{ "openapi": "3.0.3", "info": { "title": "SignalShelf - Social Media Scraper API", "version": "1.1.0", "description": "Real-time public data from Instagram, TikTok, YouTube, X, LinkedIn, Facebook, Threads, Reddit, Google Maps, app stores and more. Profiles, posts, comments, reels, transcripts, ad libraries and search. Drop-in compatible with ScrapeCreators paths and response shapes. Median response 1.2 s. Failed calls are free." }, "servers": [ { "url": "https://signalshelf.dev" } ], "tags": [ { "name": "Amazon" }, { "name": "App Store" }, { "name": "Apple Music" }, { "name": "Bluesky" }, { "name": "Cosmos" }, { "name": "Facebook" }, { "name": "Google" }, { "name": "Google Maps" }, { "name": "Google Play" }, { "name": "Instagram" }, { "name": "Kick" }, { "name": "Komi" }, { "name": "Link in bio" }, { "name": "LinkedIn" }, { "name": "Linkme" }, { "name": "Linktree" }, { "name": "Outscraper" }, { "name": "Pillar" }, { "name": "Pinterest" }, { "name": "Reddit" }, { "name": "Rumble" }, { "name": "Snapchat" }, { "name": "SoundCloud" }, { "name": "Spotify" }, { "name": "Telegram" }, { "name": "Threads" }, { "name": "TikTok" }, { "name": "Tripadvisor" }, { "name": "Trustpilot" }, { "name": "Truth Social" }, { "name": "Twitch" }, { "name": "Web" }, { "name": "X (Twitter)" }, { "name": "YouTube" } ], "paths": { "/v1/amazon/product": { "get": { "operationId": "amazonProduct", "summary": "Amazon product details", "tags": [ "Amazon" ], "description": "Public Amazon product page: title, brand, price, rating, review count, star histogram (%), “Customers say” summary, availability, feature bullets, breadcrumbs, images.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "asin", "in": "query", "required": false, "description": "Amazon ASIN. One of asin or url is required.", "schema": { "type": "string", "pattern": "^[A-Za-z0-9]{10}$", "maxLength": 10 }, "example": "B0CHX1W1XY" }, { "name": "url", "in": "query", "required": false, "description": "Amazon product URL (/dp/ASIN or /gp/product/ASIN).", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.amazon.in/dp/B0CHX1W1XY" }, { "name": "domain", "in": "query", "required": false, "description": "Amazon marketplace (default amazon.com, or taken from url).", "schema": { "type": "string", "enum": [ "amazon.com", "amazon.in", "amazon.co.uk", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.ca", "amazon.com.au", "amazon.co.jp", "amazon.com.mx", "amazon.com.br", "amazon.ae", "amazon.sg", "amazon.nl" ] }, "example": "amazon.in" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/amazon/reviews": { "get": { "operationId": "amazonReviews", "summary": "Amazon product reviews (top, guest view)", "tags": [ "Amazon" ], "description": "Top reviews Amazon renders on the product page for logged-out visitors (typically 8–13). amazon.com hides reviews behind sign-in for guests (503 SOURCE_ACCESS_RESTRICTED); amazon.in and other marketplaces still show them. The paginated /product-reviews pages require sign-in, so no cursor.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "asin", "in": "query", "required": false, "description": "Amazon ASIN. One of asin or url is required.", "schema": { "type": "string", "pattern": "^[A-Za-z0-9]{10}$", "maxLength": 10 }, "example": "B0CHX1W1XY" }, { "name": "url", "in": "query", "required": false, "description": "Amazon product URL (/dp/ASIN or /gp/product/ASIN).", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.amazon.in/dp/B0CHX1W1XY" }, { "name": "domain", "in": "query", "required": false, "description": "Amazon marketplace (default amazon.com, or taken from url).", "schema": { "type": "string", "enum": [ "amazon.com", "amazon.in", "amazon.co.uk", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.ca", "amazon.com.au", "amazon.co.jp", "amazon.com.mx", "amazon.com.br", "amazon.ae", "amazon.sg", "amazon.nl" ] }, "example": "amazon.in" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/amazon/shop": { "get": { "operationId": "amazonShop", "summary": "Amazon influencer storefront", "tags": [ "Amazon" ], "description": "Profile and idea lists/posts (with product ASINs, images, prices) of a public Amazon influencer storefront. Paginate with pageToken.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Amazon storefront URL.", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.amazon.com/shop/sydneydelrey" }, { "name": "pageToken", "in": "query", "required": false, "description": "pageToken from a previous response.", "schema": { "type": "string", "maxLength": 600 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/app-store/app": { "get": { "operationId": "appStoreApp", "summary": "App Store app details", "tags": [ "App Store" ], "description": "Public App Store metadata via the iTunes lookup API: title, developer, rating + count, price, category, screenshots, version, release notes.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "app_id", "in": "query", "required": true, "description": "Numeric App Store id (e.g. 389801252), id-prefixed id, or apps.apple.com URL. app-store/app also accepts a bundle id.", "schema": { "type": "string", "maxLength": 200 }, "example": "389801252" }, { "name": "country", "in": "query", "required": false, "description": "Two-letter country code.", "schema": { "type": "string", "pattern": "^[A-Za-z]{2}$", "maxLength": 2 }, "example": "us" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/app-store/reviews": { "get": { "operationId": "appStoreReviews", "summary": "App Store customer reviews", "tags": [ "App Store" ], "description": "Public App Store customer reviews from Apple’s customer-reviews RSS JSON (50 per page, up to 10 pages = 500 most recent/helpful per country).\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "app_id", "in": "query", "required": true, "description": "Numeric App Store id (e.g. 389801252), id-prefixed id, or apps.apple.com URL. app-store/app also accepts a bundle id.", "schema": { "type": "string", "maxLength": 200 }, "example": "389801252" }, { "name": "country", "in": "query", "required": false, "description": "Two-letter country code.", "schema": { "type": "string", "pattern": "^[A-Za-z]{2}$", "maxLength": 2 }, "example": "us" }, { "name": "sort", "in": "query", "required": false, "description": "Sort order (default mostrecent).", "schema": { "type": "string", "enum": [ "mostrecent", "mosthelpful" ] } }, { "name": "cursor", "in": "query", "required": false, "description": "Page number 1–10 from a previous response.", "schema": { "type": "string", "pattern": "^(?:[1-9]|10)$", "maxLength": 2 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/cosmos/cluster": { "get": { "operationId": "cosmosCluster", "summary": "Cosmos cluster", "tags": [ "Cosmos" ], "description": "Public Cosmos cluster (collection) metadata: name, description, owner, element and follower counts.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Cosmos cluster URL (https://www.cosmos.so//).", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.cosmos.so/athenacalderone/assembler-i" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/cosmos/cluster/posts": { "get": { "operationId": "cosmosClusterPosts", "summary": "Cosmos cluster elements", "tags": [ "Cosmos" ], "description": "Elements in a public Cosmos cluster, paginated.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Cosmos cluster URL (https://www.cosmos.so//).", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.cosmos.so/athenacalderone/assembler-i" }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor from a previous response.", "schema": { "type": "string", "maxLength": 512 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/cosmos/post": { "get": { "operationId": "cosmosPost", "summary": "Cosmos element", "tags": [ "Cosmos" ], "description": "One public Cosmos element (post) with media, source, caption and save counts.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Cosmos element URL (https://www.cosmos.so/e/) or numeric id.", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.cosmos.so/e/1765964396" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/cosmos/profile": { "get": { "operationId": "cosmosProfile", "summary": "Cosmos public profile", "tags": [ "Cosmos" ], "description": "Public Cosmos user profile: bio, website, social links, element/cluster/follower counts.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "handle", "in": "query", "required": true, "description": "Cosmos username (no @), or a cosmos.so profile URL.", "schema": { "type": "string", "maxLength": 64 }, "example": "athenacalderone" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/cosmos/search": { "get": { "operationId": "cosmosSearch", "summary": "Cosmos element search", "tags": [ "Cosmos" ], "description": "Global Cosmos element search as a logged-out visitor, paginated.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Search term.", "schema": { "type": "string", "maxLength": 200 }, "example": "architecture" }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor from a previous response.", "schema": { "type": "string", "maxLength": 512 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/cosmos/user/clusters": { "get": { "operationId": "cosmosUserClusters", "summary": "Cosmos user clusters", "tags": [ "Cosmos" ], "description": "Public clusters (collections) owned by a user, paginated.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "handle", "in": "query", "required": true, "description": "Cosmos username (no @), or a cosmos.so profile URL.", "schema": { "type": "string", "maxLength": 64 }, "example": "athenacalderone" }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor from a previous response.", "schema": { "type": "string", "maxLength": 512 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/cosmos/user/posts": { "get": { "operationId": "cosmosUserPosts", "summary": "Cosmos user elements", "tags": [ "Cosmos" ], "description": "Public elements (saved images/videos/links) on a user’s profile, newest first, paginated.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "handle", "in": "query", "required": true, "description": "Cosmos username (no @), or a cosmos.so profile URL.", "schema": { "type": "string", "maxLength": 64 }, "example": "athenacalderone" }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor from a previous response.", "schema": { "type": "string", "maxLength": 512 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/facebook/adLibrary/ad": { "get": { "operationId": "facebookAdLibraryAd", "summary": "Get one ad from the public Meta Ad Library", "tags": [ "Facebook" ], "description": "Ad archive record (creative text, media, dates, platforms, page) from facebook.com/ads/library/?id=… . get_transcript adds the transcript status (see facebook/adLibrary/ad/transcript).\n\nCost: 2 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "id", "in": "query", "required": false, "description": "Ad Library ID (ad_archive_id).", "schema": { "type": "string", "pattern": "^\\d{5,25}$", "maxLength": 512 }, "example": "1016451784037642" }, { "name": "url", "in": "query", "required": false, "description": "Ad Library URL containing ?id=…", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "get_transcript", "in": "query", "required": false, "description": "get_transcript", "schema": { "type": "boolean" } }, { "name": "allow_long_transcription", "in": "query", "required": false, "description": "Accepted for compatibility; ignored (no speech-to-text is run).", "schema": { "type": "boolean" } }, { "name": "trim", "in": "query", "required": false, "description": "trim", "schema": { "type": "boolean" } }, { "name": "cache_max_age", "in": "query", "required": false, "description": "Accepted for compatibility; ignored (use freshness).", "schema": { "type": "string", "maxLength": 512 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/facebook/adLibrary/ad/transcript": { "get": { "operationId": "facebookAdLibraryAdTranscript", "summary": "Transcript for a Meta Ad Library video ad", "tags": [ "Facebook" ], "description": "Meta's public Ad Library record exposes no caption tracks, so video ads are transcribed with speech-to-text on the ad's public video file (status \"asr\", transcript_source \"ai\"; first video only). Non-video ads return status \"no_video\"; if speech-to-text is not configured, status \"needs_asr\" with the video URLs.\n\nCost: 2 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "id", "in": "query", "required": false, "description": "Ad Library ID.", "schema": { "type": "string", "pattern": "^\\d{5,25}$", "maxLength": 512 }, "example": "1702938977100376" }, { "name": "url", "in": "query", "required": false, "description": "Ad Library URL.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "allow_long_transcription", "in": "query", "required": false, "description": "Speech-to-text: transcribe up to 10 min instead of the first 2 min.", "schema": { "type": "boolean" } }, { "name": "cache_max_age", "in": "query", "required": false, "description": "Accepted for compatibility; ignored (use freshness).", "schema": { "type": "string", "maxLength": 512 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/facebook/adLibrary/company/ads": { "get": { "operationId": "facebookAdLibraryCompanyAds", "summary": "List a Facebook page's ads from the public Meta Ad Library", "tags": [ "Facebook" ], "description": "All ads run by one page (view_all_page_id). Pass pageId, or companyName to resolve the page through the library's own typeahead first.\n\nCost: 2 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "pageId", "in": "query", "required": false, "description": "Facebook page ID.", "schema": { "type": "string", "pattern": "^\\d{3,25}$", "maxLength": 512 }, "example": "15087023444" }, { "name": "companyName", "in": "query", "required": false, "description": "Advertiser name; resolved to the top typeahead page match.", "schema": { "type": "string", "maxLength": 512 } }, { "name": "country", "in": "query", "required": false, "description": "ISO-3166 alpha-2 country or ALL (default).", "schema": { "type": "string", "maxLength": 512 } }, { "name": "status", "in": "query", "required": false, "description": "ACTIVE, INACTIVE or ALL (default).", "schema": { "type": "string", "enum": [ "ACTIVE", "INACTIVE", "ALL" ], "maxLength": 512 } }, { "name": "media_type", "in": "query", "required": false, "description": "ALL (default), IMAGE, VIDEO, MEME, IMAGE_AND_MEME, NONE.", "schema": { "type": "string", "enum": [ "ALL", "IMAGE", "VIDEO", "MEME", "IMAGE_AND_MEME", "NONE" ], "maxLength": 512 } }, { "name": "language", "in": "query", "required": false, "description": "Content language ISO-639-1 code.", "schema": { "type": "string", "maxLength": 512 } }, { "name": "sort_by", "in": "query", "required": false, "description": "total_impressions (default) or relevancy_monthly_grouped.", "schema": { "type": "string", "enum": [ "total_impressions", "relevancy_monthly_grouped" ], "maxLength": 512 } }, { "name": "start_date", "in": "query", "required": false, "description": "YYYY-MM-DD.", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "maxLength": 512 } }, { "name": "end_date", "in": "query", "required": false, "description": "YYYY-MM-DD.", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "maxLength": 512 } }, { "name": "trim", "in": "query", "required": false, "description": "trim", "schema": { "type": "boolean" } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque pagination cursor returned by the previous page.", "schema": { "type": "string", "maxLength": 4096 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/facebook/adLibrary/search/ads": { "get": { "operationId": "facebookAdLibrarySearchAds", "summary": "Search the public Meta Ad Library (all ad types, all countries)", "tags": [ "Facebook" ], "description": "Keyword search of facebook.com/ads/library as a logged-out guest. Covers every ad type and country the public site shows. First page comes from the server-rendered page; later pages replay the site's AdLibrarySearchPaginationQuery with the returned cursor.\n\nCost: 2 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Keyword or phrase.", "schema": { "type": "string", "maxLength": 512 }, "example": "nike" }, { "name": "sort_by", "in": "query", "required": false, "description": "total_impressions (default) or relevancy_monthly_grouped.", "schema": { "type": "string", "enum": [ "total_impressions", "relevancy_monthly_grouped" ], "maxLength": 512 } }, { "name": "search_type", "in": "query", "required": false, "description": "keyword_unordered (default) or keyword_exact_phrase.", "schema": { "type": "string", "enum": [ "keyword_unordered", "keyword_exact_phrase" ], "maxLength": 512 } }, { "name": "ad_type", "in": "query", "required": false, "description": "all (default) or political_and_issue_ads.", "schema": { "type": "string", "enum": [ "all", "political_and_issue_ads" ], "maxLength": 512 } }, { "name": "country", "in": "query", "required": false, "description": "ISO-3166 alpha-2 country or ALL (default).", "schema": { "type": "string", "maxLength": 512 }, "example": "ALL" }, { "name": "language", "in": "query", "required": false, "description": "Content language ISO-639-1 code, e.g. en.", "schema": { "type": "string", "maxLength": 512 } }, { "name": "status", "in": "query", "required": false, "description": "ACTIVE (default), INACTIVE or ALL.", "schema": { "type": "string", "enum": [ "ACTIVE", "INACTIVE", "ALL" ], "maxLength": 512 } }, { "name": "media_type", "in": "query", "required": false, "description": "ALL (default), IMAGE, VIDEO, MEME, IMAGE_AND_MEME, NONE.", "schema": { "type": "string", "enum": [ "ALL", "IMAGE", "VIDEO", "MEME", "IMAGE_AND_MEME", "NONE" ], "maxLength": 512 } }, { "name": "start_date", "in": "query", "required": false, "description": "Ads delivered on/after YYYY-MM-DD.", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "maxLength": 512 } }, { "name": "end_date", "in": "query", "required": false, "description": "Ads delivered on/before YYYY-MM-DD.", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "maxLength": 512 } }, { "name": "trim", "in": "query", "required": false, "description": "Return a slimmer ad object (no cards/extra media).", "schema": { "type": "boolean" } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque pagination cursor returned by the previous page.", "schema": { "type": "string", "maxLength": 4096 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/facebook/adLibrary/search/companies": { "get": { "operationId": "facebookAdLibrarySearchCompanies", "summary": "Find advertisers (pages) in the public Meta Ad Library", "tags": [ "Facebook" ], "description": "Runs the library's own typeahead (useAdLibraryTypeaheadSuggestionDataSourceQuery) as a guest.\n\nCost: 2 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Advertiser name.", "schema": { "type": "string", "maxLength": 512 }, "example": "adidas" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/facebook/event/details": { "get": { "operationId": "facebookEventDetails", "summary": "Public event details", "tags": [ "Facebook" ], "description": "Name, time, place, description, host and counts for one public event.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "id", "in": "query", "required": false, "description": "Event id.", "schema": { "type": "string", "pattern": "^\\d{5,25}$", "maxLength": 2048 }, "example": "1474625497812411" }, { "name": "url", "in": "query", "required": false, "description": "Event URL.", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.facebook.com/events/1474625497812411/" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/facebook/events": { "get": { "operationId": "facebookEvents", "summary": "City events feed", "tags": [ "Facebook" ], "description": "Public events suggested for a city from a Facebook events explore URL (e.g. https://www.facebook.com/events/explore/us-new-york/108424279189115/). Optional `time` filter.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Facebook events explore URL (or a numeric city id).", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.facebook.com/events/explore/us-new-york/108424279189115/" }, { "name": "time", "in": "query", "required": false, "description": "today | tomorrow | this_week | next_week", "schema": { "type": "string", "enum": [ "today", "tomorrow", "this_week", "next_week" ], "maxLength": 2048 }, "example": "this_week" }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque pagination cursor returned as `cursor` by the previous page.", "schema": { "type": "string", "maxLength": 8192 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/facebook/events/search": { "get": { "operationId": "facebookEventsSearch", "summary": "Search public events", "tags": [ "Facebook" ], "description": "Keyword search over public Facebook events. Paginate with `cursor`.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Search keywords.", "schema": { "type": "string", "maxLength": 200 }, "example": "concert" }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque pagination cursor returned as `cursor` by the previous page.", "schema": { "type": "string", "maxLength": 8192 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/facebook/group": { "get": { "operationId": "facebookGroup", "summary": "Public group", "tags": [ "Facebook" ], "description": "Name, privacy, member count and description of a public group (private groups are refused).\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": false, "description": "Public group URL.", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.facebook.com/groups/nasaspaceflight/" }, { "name": "group_id", "in": "query", "required": false, "description": "Numeric group id.", "schema": { "type": "string", "pattern": "^\\d{5,25}$", "maxLength": 2048 }, "example": "500021788642180" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/facebook/group/posts": { "get": { "operationId": "facebookGroupPosts", "summary": "Public group posts", "tags": [ "Facebook" ], "description": "Posts Facebook shows logged-out visitors of a public group (usually the first few featured/relevant posts; deeper pagination requires login).\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": false, "description": "Public group URL.", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.facebook.com/groups/nasaspaceflight/" }, { "name": "group_id", "in": "query", "required": false, "description": "Numeric group id.", "schema": { "type": "string", "pattern": "^\\d{5,25}$", "maxLength": 2048 }, "example": "500021788642180" }, { "name": "sort_by", "in": "query", "required": false, "description": "Ignored logged-out (Facebook decides the order).", "schema": { "type": "string", "maxLength": 40 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque pagination cursor returned as `cursor` by the previous page.", "schema": { "type": "string", "maxLength": 8192 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/facebook/marketplace/item": { "get": { "operationId": "facebookMarketplaceItem", "summary": "Marketplace listing", "tags": [ "Facebook" ], "description": "One public Marketplace listing: title, price, description, photos, location and seller display name.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "id", "in": "query", "required": false, "description": "Listing id.", "schema": { "type": "string", "pattern": "^\\d{5,25}$", "maxLength": 2048 }, "example": "1126903120093538" }, { "name": "url", "in": "query", "required": false, "description": "Listing URL.", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.facebook.com/marketplace/item/1126903120093538/" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/facebook/marketplace/location/search": { "get": { "operationId": "facebookMarketplaceLocationSearch", "summary": "Marketplace location lookup", "tags": [ "Facebook" ], "description": "Resolve a city / neighbourhood / postal code into Marketplace location ids with latitude and longitude.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Place name or postal code.", "schema": { "type": "string", "maxLength": 120 }, "example": "Austin" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/facebook/marketplace/search": { "get": { "operationId": "facebookMarketplaceSearch", "summary": "Marketplace search", "tags": [ "Facebook" ], "description": "Search public Marketplace listings around a latitude/longitude with optional filters. Paginate with `cursor`.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "query", "in": "query", "required": false, "description": "Search keywords (omit to browse).", "schema": { "type": "string", "maxLength": 200 }, "example": "bike" }, { "name": "lat", "in": "query", "required": true, "description": "Latitude.", "schema": { "type": "number", "minimum": -90, "maximum": 90 }, "example": 40.7142 }, { "name": "lng", "in": "query", "required": true, "description": "Longitude.", "schema": { "type": "number", "minimum": -180, "maximum": 180 }, "example": -74.0064 }, { "name": "category_id", "in": "query", "required": false, "description": "Marketplace category id.", "schema": { "type": "string", "maxLength": 40 } }, { "name": "radius_km", "in": "query", "required": false, "description": "Search radius in km (default 65).", "schema": { "type": "number", "minimum": 1, "maximum": 500 } }, { "name": "min_price", "in": "query", "required": false, "description": "Minimum price.", "schema": { "type": "number", "minimum": 0 } }, { "name": "max_price", "in": "query", "required": false, "description": "Maximum price.", "schema": { "type": "number", "minimum": 0 } }, { "name": "sort_by", "in": "query", "required": false, "description": "best_match | price_low_to_high | price_high_to_low | date_listed_newest | distance_nearest", "schema": { "type": "string", "maxLength": 40 } }, { "name": "delivery_method", "in": "query", "required": false, "description": "all | local_pick_up | shipping", "schema": { "type": "string", "maxLength": 20 } }, { "name": "condition", "in": "query", "required": false, "description": "new | used_like_new | used_good | used_fair (comma separated)", "schema": { "type": "string", "maxLength": 80 } }, { "name": "date_listed", "in": "query", "required": false, "description": "Not supported logged-out (Facebook returns no results with this filter for guests); ignored.", "schema": { "type": "string", "maxLength": 4 } }, { "name": "availability", "in": "query", "required": false, "description": "available | sold", "schema": { "type": "string", "maxLength": 12 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque pagination cursor returned as `cursor` by the previous page.", "schema": { "type": "string", "maxLength": 8192 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/facebook/post": { "get": { "operationId": "facebookPost", "summary": "Public post", "tags": [ "Facebook" ], "description": "One public post / reel / video: text, author, counts, media (and caption-track transcript when `get_transcript=true`).\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Public post, reel, video or photo URL.", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.facebook.com/NASA/posts/pfbid02iFM3QEzUhxs8MYU7EAD1DUrHCVhGRH1jtvR2v6xoiRzKmnH4yN8PSLYXr47vif6Pl" }, { "name": "get_transcript", "in": "query", "required": false, "description": "Also fetch the video caption track when Facebook exposes one.", "schema": { "type": "boolean" } }, { "name": "allow_long_transcription", "in": "query", "required": false, "description": "Accepted for compatibility and ignored (we only read caption tracks, no speech recognition).", "schema": { "type": "boolean" } }, { "name": "cache_max_age", "in": "query", "required": false, "description": "Accepted for compatibility and ignored.", "schema": { "type": "string", "maxLength": 256 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/facebook/post/comment/replies": { "get": { "operationId": "facebookPostCommentReplies", "summary": "Comment replies", "tags": [ "Facebook" ], "description": "Replies to one comment. Use `feedback_id` and `expansion_token` from facebook/post/comments.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "feedback_id", "in": "query", "required": true, "description": "Comment feedback id.", "schema": { "type": "string", "maxLength": 512 } }, { "name": "expansion_token", "in": "query", "required": true, "description": "Comment expansion token.", "schema": { "type": "string", "maxLength": 4096 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque pagination cursor returned as `cursor` by the previous page.", "schema": { "type": "string", "maxLength": 8192 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/facebook/post/comments": { "get": { "operationId": "facebookPostComments", "summary": "Public post comments", "tags": [ "Facebook" ], "description": "Top-level comments on a public post with author, text, reactions and reply counts. Paginate with `cursor`.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": false, "description": "Public post URL.", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.facebook.com/NASA/posts/pfbid02iFM3QEzUhxs8MYU7EAD1DUrHCVhGRH1jtvR2v6xoiRzKmnH4yN8PSLYXr47vif6Pl" }, { "name": "feedback_id", "in": "query", "required": false, "description": "Post feedback id (from facebook/post).", "schema": { "type": "string", "maxLength": 512 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque pagination cursor returned as `cursor` by the previous page.", "schema": { "type": "string", "maxLength": 8192 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/facebook/post/transcript": { "get": { "operationId": "facebookPostTranscript", "summary": "Post video transcript", "tags": [ "Facebook" ], "description": "Transcript from the caption track Facebook exposes for a public video/reel (transcript_source \"captions\"). Without captions, runs speech-to-text on the video's audio-only DASH track (transcript_source \"ai\").\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Public reel / video / post URL.", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.facebook.com/reel/2500371283786705/" }, { "name": "allow_long_transcription", "in": "query", "required": false, "description": "Speech-to-text fallback: transcribe up to 10 min instead of the first 2 min.", "schema": { "type": "boolean" } }, { "name": "cache_max_age", "in": "query", "required": false, "description": "Accepted for compatibility and ignored.", "schema": { "type": "string", "maxLength": 256 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/facebook/profile": { "get": { "operationId": "facebookProfile", "summary": "Public Facebook Page profile", "tags": [ "Facebook" ], "description": "Name, category, follower/following counts, bio, links, cover and avatar of a public Page as shown to logged-out visitors.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Public Facebook Page URL or username.", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.facebook.com/NASA" }, { "name": "get_business_hours", "in": "query", "required": false, "description": "Accepted for compatibility and ignored.", "schema": { "type": "string", "maxLength": 256 } }, { "name": "include_gated_profile", "in": "query", "required": false, "description": "Accepted for compatibility and ignored.", "schema": { "type": "string", "maxLength": 256 } }, { "name": "cache_max_age", "in": "query", "required": false, "description": "Accepted for compatibility and ignored.", "schema": { "type": "string", "maxLength": 256 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/facebook/profile/events": { "get": { "operationId": "facebookProfileEvents", "summary": "Public Page events", "tags": [ "Facebook" ], "description": "Upcoming (or recent) events hosted by a public Page.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Public Facebook Page URL or username.", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.facebook.com/NASA" }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque pagination cursor returned as `cursor` by the previous page.", "schema": { "type": "string", "maxLength": 8192 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/facebook/profile/photos": { "get": { "operationId": "facebookProfilePhotos", "summary": "Public Page photos", "tags": [ "Facebook" ], "description": "Photos uploaded by a public Page. Paginate with `cursor` (or the raw `cursor` + `next_page_id` pair).\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Public Facebook Page URL or username.", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.facebook.com/NASA" }, { "name": "next_page_id", "in": "query", "required": false, "description": "Photo collection id returned as `next_page_id` (only needed with a raw Facebook cursor).", "schema": { "type": "string", "maxLength": 1024 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque pagination cursor returned as `cursor` by the previous page.", "schema": { "type": "string", "maxLength": 8192 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/facebook/profile/posts": { "get": { "operationId": "facebookProfilePosts", "summary": "Public Page posts", "tags": [ "Facebook" ], "description": "Recent public posts from a Page timeline with text, media, reactions, comments and shares. Paginate with `cursor`.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": false, "description": "Public Facebook Page URL or username.", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.facebook.com/NASA" }, { "name": "pageId", "in": "query", "required": false, "description": "Numeric Page/profile id (skips the profile lookup).", "schema": { "type": "string", "pattern": "^\\d{5,25}$", "maxLength": 2048 }, "example": "100044561550831" }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque pagination cursor returned as `cursor` by the previous page.", "schema": { "type": "string", "maxLength": 8192 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/facebook/profile/reels": { "get": { "operationId": "facebookProfileReels", "summary": "Public Page reels", "tags": [ "Facebook" ], "description": "Reels/videos posted on a public Page, collected from its public timeline (logged-out Facebook hides the dedicated Reels tab). Paginate with `cursor`.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Public Facebook Page URL or username.", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.facebook.com/NASA" }, { "name": "next_page_id", "in": "query", "required": false, "description": "Accepted for compatibility and ignored (pass `cursor` alone).", "schema": { "type": "string", "maxLength": 256 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque pagination cursor returned as `cursor` by the previous page.", "schema": { "type": "string", "maxLength": 8192 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/facebook/search/videos": { "get": { "operationId": "facebookSearchVideos", "summary": "Search public videos", "tags": [ "Facebook" ], "description": "Keyword search over public Facebook videos/reels. Paginate with `cursor`.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Search keywords.", "schema": { "type": "string", "maxLength": 200 }, "example": "mars rover" }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque pagination cursor returned as `cursor` by the previous page.", "schema": { "type": "string", "maxLength": 8192 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/find-social-profiles": { "get": { "operationId": "findSocialProfiles", "summary": "Find a creator's other social profiles", "tags": [ "Web" ], "description": "Collects public profile links from the source profile (bio links, website), its link-in-bio page (Linktree, Komi, Pillar, Linkme, Lnk.Bio via our guest ops), the creator website's social links, and one search-engine query for the handle. Same-handle URLs on other platforms are listed as unverified candidates.\n\nCost: 2 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "handle", "in": "query", "required": true, "description": "Public handle on that platform (no @).", "schema": { "type": "string", "maxLength": 100 } }, { "name": "cache_max_age", "in": "query", "required": false, "description": "Accepted for compatibility and ignored (cache window).", "schema": { "type": "string", "maxLength": 512 } }, { "name": "platform__param", "in": "query", "required": true, "description": "Source platform.", "schema": { "type": "string", "enum": [ "instagram", "tiktok", "youtube", "x", "twitter", "facebook" ], "maxLength": 512 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/google-maps/photos": { "get": { "operationId": "googleMapsPhotos", "summary": "Google Maps place photo URLs", "tags": [ "Google Maps" ], "description": "Photo URLs (full-size and thumbnail) from the place’s public payload. Returns the photo set shown in the place panel (not paginated).\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "place_id", "in": "query", "required": false, "description": "Google place_id (ChIJ…), Google feature id (0x…:0x…), or numeric CID. One of place_id or url is required.", "schema": { "type": "string", "maxLength": 300 }, "example": "ChIJifIePKtZwokRVZ-UdRGkZzs" }, { "name": "url", "in": "query", "required": false, "description": "Google Maps place URL (google.com/maps/place/… or maps.app.goo.gl/…).", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.google.com/maps/place/Joe's+Pizza+Broadway/data=!4m2!3m1!1s0x89c259ab3c1ef289:0x3b67a41175949f55" }, { "name": "language", "in": "query", "required": false, "description": "Interface/content language code.", "schema": { "type": "string", "pattern": "^[A-Za-z]{2,3}(?:[-_][A-Za-z0-9]{2,4})?$", "maxLength": 10 }, "example": "en" }, { "name": "region", "in": "query", "required": false, "description": "Two-letter country code.", "schema": { "type": "string", "pattern": "^[A-Za-z]{2}$", "maxLength": 2 }, "example": "us" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/google-maps/place": { "get": { "operationId": "googleMapsPlace", "summary": "Google Maps place details", "tags": [ "Google Maps" ], "description": "Place details from Google Maps’ own place payload: identity, address, coordinates, rating + histogram, categories, contact, hours, description.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "place_id", "in": "query", "required": false, "description": "Google place_id (ChIJ…), Google feature id (0x…:0x…), or numeric CID. One of place_id or url is required.", "schema": { "type": "string", "maxLength": 300 }, "example": "ChIJifIePKtZwokRVZ-UdRGkZzs" }, { "name": "url", "in": "query", "required": false, "description": "Google Maps place URL (google.com/maps/place/… or maps.app.goo.gl/…).", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.google.com/maps/place/Joe's+Pizza+Broadway/data=!4m2!3m1!1s0x89c259ab3c1ef289:0x3b67a41175949f55" }, { "name": "language", "in": "query", "required": false, "description": "Interface/content language code.", "schema": { "type": "string", "pattern": "^[A-Za-z]{2,3}(?:[-_][A-Za-z0-9]{2,4})?$", "maxLength": 10 }, "example": "en" }, { "name": "region", "in": "query", "required": false, "description": "Two-letter country code.", "schema": { "type": "string", "pattern": "^[A-Za-z]{2}$", "maxLength": 2 }, "example": "us" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/google-maps/reviews": { "get": { "operationId": "googleMapsReviews", "summary": "Google Maps place reviews (top, guest view)", "tags": [ "Google Maps" ], "description": "Reviews Google Maps shows a logged-out visitor (the top “most relevant” set, usually ~5) plus total count and star histogram. Google serves logged-out users a “limited view” — the full review list, sorting and pagination (listugcposts) return PERMISSION_DENIED without sign-in, so this endpoint is not paginated. With a search API key configured, returns the full review list (20 per page, sortable, paginated) via a Google results API; otherwise the ~5 reviews logged-out Maps shows.\n\nCost: varies (see description) credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "place_id", "in": "query", "required": false, "description": "Google place_id (ChIJ…), Google feature id (0x…:0x…), or numeric CID. One of place_id or url is required.", "schema": { "type": "string", "maxLength": 300 }, "example": "ChIJifIePKtZwokRVZ-UdRGkZzs" }, { "name": "url", "in": "query", "required": false, "description": "Google Maps place URL (google.com/maps/place/… or maps.app.goo.gl/…).", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.google.com/maps/place/Joe's+Pizza+Broadway/data=!4m2!3m1!1s0x89c259ab3c1ef289:0x3b67a41175949f55" }, { "name": "language", "in": "query", "required": false, "description": "Interface/content language code.", "schema": { "type": "string", "pattern": "^[A-Za-z]{2,3}(?:[-_][A-Za-z0-9]{2,4})?$", "maxLength": 10 }, "example": "en" }, { "name": "region", "in": "query", "required": false, "description": "Two-letter country code.", "schema": { "type": "string", "pattern": "^[A-Za-z]{2}$", "maxLength": 2 }, "example": "us" }, { "name": "limit", "in": "query", "required": false, "description": "How many reviews you need (default 20). Up to 5 with default order uses the free logged-out path (1 credit); more uses the full review API at 2 credits per 20 reviews.", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "sort", "in": "query", "required": false, "description": "Review order (full mode).", "schema": { "type": "string", "enum": [ "most_relevant", "newest", "highest_rating", "lowest_rating" ] } }, { "name": "cursor", "in": "query", "required": false, "description": "Pagination cursor from the previous page (full mode).", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "source", "in": "query", "required": false, "description": "auto (default): full reviews when available; guest: logged-out Maps only.", "schema": { "type": "string", "enum": [ "auto", "guest" ] } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/google-maps/search": { "get": { "operationId": "googleMapsSearch", "summary": "Search Google Maps places", "tags": [ "Google Maps" ], "description": "Searches Google Maps as a logged-out guest (the map’s own tbm=map search payload) and returns normalized places: name, place_id, address, coordinates, rating, review count, categories, phone, website and opening hours. 20 places per upstream page; cursor is an offset.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "query", "in": "query", "required": true, "description": "What to search for, e.g. “pizza” or “dentists in Austin TX”.", "schema": { "type": "string", "maxLength": 300 }, "example": "pizza" }, { "name": "location", "in": "query", "required": false, "description": "Optional location appended to the query (“in ”).", "schema": { "type": "string", "maxLength": 200 }, "example": "New York, NY" }, { "name": "limit", "in": "query", "required": false, "description": "Places to return (default 20).", "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "example": 20 }, { "name": "cursor", "in": "query", "required": false, "description": "Offset cursor from a previous response.", "schema": { "type": "string", "pattern": "^\\d{1,4}$", "maxLength": 6 } }, { "name": "language", "in": "query", "required": false, "description": "Interface/content language code.", "schema": { "type": "string", "pattern": "^[A-Za-z]{2,3}(?:[-_][A-Za-z0-9]{2,4})?$", "maxLength": 10 }, "example": "en" }, { "name": "region", "in": "query", "required": false, "description": "Two-letter country code.", "schema": { "type": "string", "pattern": "^[A-Za-z]{2}$", "maxLength": 2 }, "example": "us" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/google-play/app": { "get": { "operationId": "googlePlayApp", "summary": "Google Play app details", "tags": [ "Google Play" ], "description": "Public Google Play listing: title, developer, installs, rating + histogram, price, category, content rating, screenshots, version/update info.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "app_id", "in": "query", "required": true, "description": "Android package name.", "schema": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9_]*(?:\\.[A-Za-z0-9_]+)+$", "maxLength": 200 }, "example": "com.whatsapp" }, { "name": "language", "in": "query", "required": false, "description": "Interface/content language code.", "schema": { "type": "string", "pattern": "^[A-Za-z]{2,3}(?:[-_][A-Za-z0-9]{2,4})?$", "maxLength": 10 }, "example": "en" }, { "name": "region", "in": "query", "required": false, "description": "Two-letter country code.", "schema": { "type": "string", "pattern": "^[A-Za-z]{2}$", "maxLength": 2 }, "example": "us" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/google-play/reviews": { "get": { "operationId": "googlePlayReviews", "summary": "Google Play app reviews", "tags": [ "Google Play" ], "description": "Public Google Play reviews via the store’s own batchexecute (UsvDTd) RPC, with sort and cursor pagination.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "app_id", "in": "query", "required": true, "description": "Android package name.", "schema": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9_]*(?:\\.[A-Za-z0-9_]+)+$", "maxLength": 200 }, "example": "com.whatsapp" }, { "name": "sort", "in": "query", "required": false, "description": "Sort order (default newest).", "schema": { "type": "string", "enum": [ "most_relevant", "newest", "rating" ] } }, { "name": "limit", "in": "query", "required": false, "description": "Reviews per page (default 40).", "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "example": 40 }, { "name": "cursor", "in": "query", "required": false, "description": "Pagination token from a previous response.", "schema": { "type": "string", "maxLength": 2000 } }, { "name": "language", "in": "query", "required": false, "description": "Interface/content language code.", "schema": { "type": "string", "pattern": "^[A-Za-z]{2,3}(?:[-_][A-Za-z0-9]{2,4})?$", "maxLength": 10 }, "example": "en" }, { "name": "region", "in": "query", "required": false, "description": "Two-letter country code.", "schema": { "type": "string", "pattern": "^[A-Za-z]{2}$", "maxLength": 2 }, "example": "us" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/google/ad": { "get": { "operationId": "googleAd", "summary": "Get one ad from Google Ads Transparency Center", "tags": [ "Google" ], "description": "GetCreativeById + GetAdvertiserById RPCs, plus creative text/video ID parsed from the public preview payload.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Ad URL: https://adstransparency.google.com/advertiser/AR…/creative/CR…", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://adstransparency.google.com/advertiser/AR16735076323512287233/creative/CR12178605751807246337" }, { "name": "cache_max_age", "in": "query", "required": false, "description": "Accepted for compatibility; ignored (use freshness).", "schema": { "type": "string", "maxLength": 512 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/google/adLibrary/advertisers/search": { "get": { "operationId": "googleAdLibraryAdvertisersSearch", "summary": "Search advertisers/domains in Google Ads Transparency Center", "tags": [ "Google" ], "description": "Calls the Transparency Center's SearchSuggestions RPC as a guest.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Advertiser name or domain.", "schema": { "type": "string", "maxLength": 512 }, "example": "nike" }, { "name": "region", "in": "query", "required": false, "description": "Accepted for compatibility; suggestions are global (the site does not filter them by region).", "schema": { "type": "string", "maxLength": 512 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/google/company/ads": { "get": { "operationId": "googleCompanyAds", "summary": "List ads for an advertiser or domain from Google Ads Transparency Center", "tags": [ "Google" ], "description": "SearchCreatives RPC (40 per page). Filters map to the site's own payload fields. get_ad_details=true adds per-ad region stats + creative text (slower).\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "domain", "in": "query", "required": false, "description": "Advertiser website domain.", "schema": { "type": "string", "maxLength": 512 }, "example": "nike.com" }, { "name": "advertiser_id", "in": "query", "required": false, "description": "Transparency advertiser ID (AR…).", "schema": { "type": "string", "pattern": "^AR\\d{10,30}$", "maxLength": 512 } }, { "name": "topic", "in": "query", "required": false, "description": "all (default) or political.", "schema": { "type": "string", "enum": [ "all", "political" ], "maxLength": 512 } }, { "name": "region", "in": "query", "required": false, "description": "ISO alpha-2 region where shown (default anywhere).", "schema": { "type": "string", "maxLength": 512 } }, { "name": "start_date", "in": "query", "required": false, "description": "YYYY-MM-DD.", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "maxLength": 512 } }, { "name": "end_date", "in": "query", "required": false, "description": "YYYY-MM-DD.", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "maxLength": 512 } }, { "name": "format", "in": "query", "required": false, "description": "Creative format.", "schema": { "type": "string", "enum": [ "text", "image", "video" ], "maxLength": 512 } }, { "name": "get_ad_details", "in": "query", "required": false, "description": "Fetch per-ad details (up to 20 per page). Extra fields are not part of the ScrapeCreators-shaped body.", "schema": { "type": "boolean" } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque pagination cursor returned by the previous page.", "schema": { "type": "string", "maxLength": 4096 } }, { "name": "platform__param", "in": "query", "required": false, "description": "Surface filter.", "schema": { "type": "string", "enum": [ "google_maps", "google_play", "google_search", "google_shopping", "youtube" ], "maxLength": 512 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/google/news": { "get": { "operationId": "googleNews", "summary": "Google News search", "tags": [ "Google" ], "description": "Google News results for a query from the public RSS search feed: title, publisher, published time, Google News article link. Up to 100 items.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Search query (Google News operators like site: and intitle: work).", "schema": { "type": "string", "maxLength": 500 }, "example": "openai" }, { "name": "time_range", "in": "query", "required": false, "description": "Only items newer than this.", "schema": { "type": "string", "enum": [ "1h", "1d", "7d", "30d", "1y" ] } }, { "name": "limit", "in": "query", "required": false, "description": "Items to return (default 50).", "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "example": 20 }, { "name": "language", "in": "query", "required": false, "description": "Interface/content language code.", "schema": { "type": "string", "pattern": "^[A-Za-z]{2,3}(?:[-_][A-Za-z0-9]{2,4})?$", "maxLength": 10 }, "example": "en" }, { "name": "region", "in": "query", "required": false, "description": "Two-letter country code.", "schema": { "type": "string", "pattern": "^[A-Za-z]{2}$", "maxLength": 2 }, "example": "us" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/google/search": { "get": { "operationId": "googleSearch", "summary": "Google web search (organic results)", "tags": [ "Google" ], "description": "Organic results from a public Google SERP rendered in a guest browser (plain HTTP is JavaScript-gated). Rotates exit IPs when Google rate-limits; returns SOURCE_ACCESS_RESTRICTED if every session is challenged.\n\nCost: 2 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Search query.", "schema": { "type": "string", "maxLength": 512 }, "example": "best running shoes" }, { "name": "region", "in": "query", "required": false, "description": "Two-letter country code (gl).", "schema": { "type": "string", "pattern": "^[A-Za-z]{2}$" }, "example": "us" }, { "name": "date_posted", "in": "query", "required": false, "description": "Restrict results to a recent time window.", "schema": { "type": "string", "enum": [ "last-hour", "last-day", "last-week", "last-month", "last-year" ] } }, { "name": "page", "in": "query", "required": false, "description": "Result page (10 results per page).", "schema": { "type": "integer", "minimum": 1, "maximum": 10 }, "example": 1 }, { "name": "engine", "in": "query", "required": false, "description": "auto (default): fastest available engine, Google as fallback. google: Google only (slower).", "schema": { "type": "string", "enum": [ "auto", "google" ] } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/instagram/audio/reels": { "get": { "operationId": "instagramAudioReels", "summary": "Reels using an audio (guest)", "tags": [ "Instagram" ], "description": "Reels using an original audio or song, from the public audio page.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "audio_id", "in": "query", "required": true, "description": "Instagram audio id (audio_cluster_id / original audio asset id).", "schema": { "type": "string", "pattern": "^\\d{5,25}$", "maxLength": 40 }, "example": "29154118544224370" }, { "name": "cursor", "in": "query", "required": false, "description": "Cursor (max_id) from a previous page.", "schema": { "type": "string", "maxLength": 4096 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v2/instagram/media/transcript": { "get": { "operationId": "instagramMediaTranscript", "summary": "Transcript of a public Instagram reel/video post (ASR)", "tags": [ "Instagram" ], "description": "Runs speech-to-text on the public media audio (audio-only download, whisper). Resolves the post via the guest instagram/post op; one transcript per video item (carousels up to 5). Posts without video return 404.\n\nCost: varies (see description) credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Public Instagram post or reel URL.", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.instagram.com/reel/DfJThjLOoPn/" }, { "name": "allow_long_transcription", "in": "query", "required": false, "description": "Transcribe up to 10 min (ASR_MAX_SECONDS) instead of the first 2 min (ASR_SHORT_SECONDS). Long transcription may cost extra credits.", "schema": { "type": "boolean" } }, { "name": "language", "in": "query", "required": false, "description": "Spoken language hint (ISO-639-1, e.g. \"en\"); default auto-detect.", "schema": { "type": "string", "maxLength": 8 } }, { "name": "cache_max_age", "in": "query", "required": false, "description": "Serve a cached result up to this age (e.g. 1d, 7d). Handled by the warm store.", "schema": { "type": "string", "maxLength": 8 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/instagram/post": { "get": { "operationId": "instagramPost", "summary": "Public Instagram post/reel (guest)", "tags": [ "Instagram" ], "description": "Logged-out post: caption, counts, timestamps, media URLs, carousel, tagged users, coauthors, audio, first comments.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Instagram post/reel URL or shortcode.", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.instagram.com/p/DaDJji0DY_x/" }, { "name": "trim", "in": "query", "required": false, "description": "Return a slimmer object (drops carousel/tag/coauthor arrays).", "schema": { "type": "boolean" } }, { "name": "region", "in": "query", "required": false, "description": "Proxy region. Accepted for compatibility and ignored (guest source).", "schema": { "type": "string" } }, { "name": "download_media", "in": "query", "required": false, "description": "Media download. Accepted for compatibility and ignored (guest source).", "schema": { "type": "boolean" } }, { "name": "include_play_count", "in": "query", "required": false, "description": "Play count flag. Accepted for compatibility and ignored (guest source).", "schema": { "type": "boolean" } }, { "name": "cache_max_age", "in": "query", "required": false, "description": "Upstream cache hint. Accepted for compatibility and ignored (guest source).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v2/instagram/post/comments": { "get": { "operationId": "instagramPostComments", "summary": "Public Instagram post comments (guest)", "tags": [ "Instagram" ], "description": "Top-level comments with cursor pagination (logged-out comments pagination query).\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Instagram post/reel URL or shortcode.", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.instagram.com/p/DaDJji0DY_x/" }, { "name": "cursor", "in": "query", "required": false, "description": "Cursor from a previous page.", "schema": { "type": "string", "maxLength": 4096 } }, { "name": "include_replies", "in": "query", "required": false, "description": "Replies are not visible to guests; reply counts are included. Accepted for compatibility and ignored (guest source).", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/instagram/profile": { "get": { "operationId": "instagramProfile", "summary": "Public Instagram profile (guest)", "tags": [ "Instagram" ], "description": "Logged-out profile: bio, links, follower/following counts, verification, highlights tray and the 12 most recent posts. posts_count is the rounded public figure (e.g. \"32K\") and only present when served from a full page load. Business contact fields (business_email, business_phone_number, business_address_json, category) are filled only for business/professional accounts and only when the server enables GUEST_BUSINESS_CONTACT=on; otherwise null. Never returned for personal accounts.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "handle", "in": "query", "required": true, "description": "Public Instagram username (without @).", "schema": { "type": "string", "pattern": "^@?[A-Za-z0-9._]{1,30}$", "maxLength": 30 }, "example": "virat.kohli" }, { "name": "trim", "in": "query", "required": false, "description": "Return a slimmer object (drops carousel/tag/coauthor arrays).", "schema": { "type": "boolean" } }, { "name": "cache_max_age", "in": "query", "required": false, "description": "Upstream cache hint. Accepted for compatibility and ignored (guest source).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v2/instagram/reels/search": { "get": { "operationId": "instagramReelsSearch", "summary": "Instagram reels search (search-engine derived)", "tags": [ "Instagram" ], "description": "Built from public search-engine results (DuckDuckGo / Startpage / Brave / Bing, whichever serves a guest) for a site:-restricted query (site:instagram.com/reel ). The top N reels are hydrated through the public instagram/post lookup (counts, owner, media).\n\nCost: 2 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Search query.", "schema": { "type": "string", "maxLength": 300 } }, { "name": "date_posted", "in": "query", "required": false, "description": "last-week / last-month / last-year freshness filter (search-engine side).", "schema": { "type": "string", "enum": [ "last-week", "last-month", "last-year" ], "maxLength": 512 } }, { "name": "page", "in": "query", "required": false, "description": "Result page (1-based).", "schema": { "type": "integer", "minimum": 1, "maximum": 10 } }, { "name": "hydrate", "in": "query", "required": false, "description": "SignalShelf extension: how many top results to hydrate through the matching public guest op (default 3, max 8, 0 = search-engine fields only).", "schema": { "type": "integer", "minimum": 0, "maximum": 8 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/instagram/search": { "get": { "operationId": "instagramSearch", "summary": "Instagram account search (search-engine derived)", "tags": [ "Instagram" ], "description": "Built from public search-engine results (DuckDuckGo / Startpage / Brave / Bing, whichever serves a guest) for a site:-restricted query (site:instagram.com ). Returns public profile usernames, display names and URLs in engine rank order; id/is_verified/profile_pic_url are null like the reference.\n\nCost: 2 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Search query.", "schema": { "type": "string", "maxLength": 300 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/instagram/search/popular": { "get": { "operationId": "instagramSearchPopular", "summary": "Instagram popular posts for a keyword (search-engine derived)", "tags": [ "Instagram" ], "description": "Built from public search-engine results (DuckDuckGo / Startpage / Brave / Bing, whichever serves a guest) for a site:-restricted query (site:instagram.com post/reel URLs, engine rank as the popularity proxy). The top N are hydrated through instagram/post. title/description/suggested_terms are null/empty (Instagram's keyword page is login-only).\n\nCost: 2 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Search query.", "schema": { "type": "string", "maxLength": 300 } }, { "name": "cursor", "in": "query", "required": false, "description": "Page cursor (the `cursor` from a previous response).", "schema": { "type": "string", "maxLength": 8 } }, { "name": "hydrate", "in": "query", "required": false, "description": "SignalShelf extension: how many top results to hydrate through the matching public guest op (default 3, max 8, 0 = search-engine fields only).", "schema": { "type": "integer", "minimum": 0, "maximum": 8 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/instagram/song/reels": { "get": { "operationId": "instagramSongReels", "summary": "Reels using a song (guest)", "tags": [ "Instagram" ], "description": "Same source as audio/reels; reference-compatible max_id pagination.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "audio_id", "in": "query", "required": true, "description": "Instagram audio id (audio_cluster_id / original audio asset id).", "schema": { "type": "string", "pattern": "^\\d{5,25}$", "maxLength": 40 }, "example": "29154118544224370" }, { "name": "max_id", "in": "query", "required": false, "description": "Cursor from a previous page.", "schema": { "type": "string", "maxLength": 4096 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/instagram/user/embed": { "get": { "operationId": "instagramUserEmbed", "summary": "Public Instagram profile embed (guest)", "tags": [ "Instagram" ], "description": "Profile embed widget: exact posts_count, followers and the latest posts with like/comment counts (reference path returns the embed html).\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "handle", "in": "query", "required": true, "description": "Public Instagram username (without @).", "schema": { "type": "string", "pattern": "^@?[A-Za-z0-9._]{1,30}$", "maxLength": 30 }, "example": "virat.kohli" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/instagram/user/highlight/detail": { "get": { "operationId": "instagramUserHighlightDetail", "summary": "Public Instagram highlight items (guest)", "tags": [ "Instagram" ], "description": "Items inside one public highlight reel (media URLs, timestamps, link/mention/hashtag stickers).\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "id", "in": "query", "required": true, "description": "Highlight id (from instagram/user/highlights).", "schema": { "type": "string", "pattern": "^(highlight:)?\\d{5,25}$", "maxLength": 40 }, "example": "18023864549864045" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/instagram/user/highlights": { "get": { "operationId": "instagramUserHighlights", "summary": "Public Instagram highlights tray (guest)", "tags": [ "Instagram" ], "description": "Highlight reels listed on the logged-out profile (id, title, cover).\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "handle", "in": "query", "required": false, "description": "Public Instagram username (required for guests).", "schema": { "type": "string", "pattern": "^@?[A-Za-z0-9._]{1,30}$", "maxLength": 30 }, "example": "virat.kohli" }, { "name": "user_id", "in": "query", "required": false, "description": "Ignored (guests cannot resolve ids); pass handle.", "schema": { "type": "string", "maxLength": 30 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v2/instagram/user/posts": { "get": { "operationId": "instagramUserPosts", "summary": "Public Instagram posts (guest)", "tags": [ "Instagram" ], "description": "Profile grid in pages of 12. Each post is enriched with like/comment counts, exact taken_at and media via one logged-out media lookup per post (require_play_counts=false skips that for speed).\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "handle", "in": "query", "required": true, "description": "Public Instagram username (without @).", "schema": { "type": "string", "pattern": "^@?[A-Za-z0-9._]{1,30}$", "maxLength": 30 }, "example": "virat.kohli" }, { "name": "next_max_id", "in": "query", "required": false, "description": "Cursor from a previous page (next_max_id).", "schema": { "type": "string", "maxLength": 4096 } }, { "name": "require_play_counts", "in": "query", "required": false, "description": "Enrich each post with counts/media (default true; false = faster, grid fields only).", "schema": { "type": "boolean" } }, { "name": "trim", "in": "query", "required": false, "description": "Return a slimmer object (drops carousel/tag/coauthor arrays).", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/instagram/user/reels": { "get": { "operationId": "instagramUserReels", "summary": "Public Instagram reels (guest)", "tags": [ "Instagram" ], "description": "Reels tab in pages of 12 with play, like and comment counts.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "handle", "in": "query", "required": false, "description": "Public Instagram username (required: user_id alone is not resolvable as a guest).", "schema": { "type": "string", "pattern": "^@?[A-Za-z0-9._]{1,30}$", "maxLength": 30 }, "example": "virat.kohli" }, { "name": "user_id", "in": "query", "required": false, "description": "Ignored unless handle is given (guests cannot resolve ids to profiles).", "schema": { "type": "string", "maxLength": 30 } }, { "name": "max_id", "in": "query", "required": false, "description": "Cursor from a previous page.", "schema": { "type": "string", "maxLength": 4096 } }, { "name": "require_play_counts", "in": "query", "required": false, "description": "Play counts are always included. Accepted for compatibility and ignored (guest source).", "schema": { "type": "boolean" } }, { "name": "trim", "in": "query", "required": false, "description": "Return a slimmer object (drops carousel/tag/coauthor arrays).", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/kick/clip": { "get": { "operationId": "kickClip", "summary": "Read a public Kick clip", "tags": [ "Kick" ], "description": "Public kick.com/api/v2/clips/{id} JSON.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Clip URL (kick.com//clips/clip_…) or clip id.", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://kick.com/xqc/clips/clip_01H811MXG4FBR62FXPE1AXABDH" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/kick/clip/transcript": { "get": { "operationId": "kickClipTranscript", "summary": "Transcript of a public Kick clip (ASR)", "tags": [ "Kick" ], "description": "Runs speech-to-text on the public media audio (audio-only download, whisper). Resolves the clip HLS playlist via the guest kick/clip op.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Kick clip URL (kick.com//clips/clip_…) or clip id.", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://kick.com/xqc/clips/clip_01H811MXG4FBR62FXPE1AXABDH" }, { "name": "allow_long_transcription", "in": "query", "required": false, "description": "Transcribe up to 10 min (ASR_MAX_SECONDS) instead of the first 2 min (ASR_SHORT_SECONDS). Long transcription may cost extra credits.", "schema": { "type": "boolean" } }, { "name": "use_ai_as_fallback", "in": "query", "required": false, "description": "Accepted for compatibility; ignored. These sources publish no captions, so the transcript is always speech-to-text (transcript_source \"ai\").", "schema": { "type": "boolean" } }, { "name": "language", "in": "query", "required": false, "description": "Spoken language hint (ISO-639-1, e.g. \"en\"); default auto-detect.", "schema": { "type": "string", "maxLength": 8 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/komi": { "get": { "operationId": "komi", "summary": "Komi page", "tags": [ "Komi" ], "description": "Profile, link modules and socials of a public Komi page (komi.io public JSON used by the page).\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Komi page URL, e.g. https://.komi.io.", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://dwyanewade.komi.io" }, { "name": "cache_max_age", "in": "query", "required": false, "description": "Accepted for reference-API compatibility; guest fetches are always live.", "schema": { "type": "string", "enum": [ "1d", "3d", "7d", "14d", "30d" ] } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/linkbio": { "get": { "operationId": "linkbio", "summary": "Lnk.Bio page", "tags": [ "Link in bio" ], "description": "Profile, links and social icons of a public Lnk.Bio page (guest browser; the site serves a JS challenge to plain HTTP).\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Lnk.Bio page URL.", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://lnk.bio/lnkbio" }, { "name": "cache_max_age", "in": "query", "required": false, "description": "Accepted for reference-API compatibility; guest fetches are always live.", "schema": { "type": "string", "enum": [ "1d", "3d", "7d", "14d", "30d" ] } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/linkedin/ad": { "get": { "operationId": "linkedinAd", "summary": "Get one ad from LinkedIn's public Ad Library", "tags": [ "LinkedIn" ], "description": "Ad detail page: creative, advertiser, payer, run dates, impressions and targeting summary.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "https://www.linkedin.com/ad-library/detail/ (or the numeric id).", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.linkedin.com/ad-library/detail/1624217084" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/linkedin/ads/search": { "get": { "operationId": "linkedinAdsSearch", "summary": "Search LinkedIn's public Ad Library", "tags": [ "LinkedIn" ], "description": "Server-rendered linkedin.com/ad-library/search loaded as a guest; next pages via the site's searchPaginationFragment.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "company", "in": "query", "required": false, "description": "Advertiser name.", "schema": { "type": "string", "maxLength": 512 }, "example": "microsoft" }, { "name": "keyword", "in": "query", "required": false, "description": "Keyword in ad text.", "schema": { "type": "string", "maxLength": 512 } }, { "name": "companyId", "in": "query", "required": false, "description": "LinkedIn company ID.", "schema": { "type": "string", "pattern": "^\\d{1,15}$", "maxLength": 512 } }, { "name": "countries", "in": "query", "required": false, "description": "Comma-separated ISO alpha-2 countries (default ALL).", "schema": { "type": "string", "maxLength": 512 } }, { "name": "startDate", "in": "query", "required": false, "description": "YYYY-MM-DD (within the last year).", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "maxLength": 512 } }, { "name": "endDate", "in": "query", "required": false, "description": "YYYY-MM-DD.", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "maxLength": 512 } }, { "name": "paginationToken", "in": "query", "required": false, "description": "Token from the previous page.", "schema": { "type": "string", "maxLength": 200 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/linkedin/company/posts": { "get": { "operationId": "linkedinCompanyPosts", "summary": "Public company posts", "tags": [ "LinkedIn" ], "description": "Recent posts shown on a public LinkedIn company page (logged-out LinkedIn shows only the latest page; page>1 returns empty).\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "LinkedIn company URL or slug.", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.linkedin.com/company/microsoft" }, { "name": "page", "in": "query", "required": false, "description": "Page number (only 1 is available logged-out).", "schema": { "type": "integer", "minimum": 1, "maximum": 10 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/linkedin/post": { "get": { "operationId": "linkedinPost", "summary": "Public LinkedIn post", "tags": [ "LinkedIn" ], "description": "Text, author, date, likes/comments counts, media and top public comments of a public post.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Public post URL (/posts/… or /feed/update/urn:li:activity:…).", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.linkedin.com/posts/microsoft_msignite-activity-7521355928982634496-cbcv" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/linkedin/post/transcript": { "get": { "operationId": "linkedinPostTranscript", "summary": "LinkedIn video transcript", "tags": [ "LinkedIn" ], "description": "Transcript from the caption track of a public LinkedIn video post (transcript_source \"captions\"). Without captions, runs speech-to-text on the progressive MP4 (transcript_source \"ai\").\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Public post URL containing a native video.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "allow_long_transcription", "in": "query", "required": false, "description": "Speech-to-text fallback: transcribe up to 10 min instead of the first 2 min.", "schema": { "type": "boolean" } }, { "name": "language", "in": "query", "required": false, "description": "Spoken language hint for speech-to-text (ISO 639-1); default auto-detect.", "schema": { "type": "string", "maxLength": 8 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/linkedin/profile": { "get": { "operationId": "linkedinProfile", "summary": "Public LinkedIn profile", "tags": [ "LinkedIn" ], "description": "What the public (logged-out) /in/ page shows: name, headline, location, current/past organisations, education, follower count, recent public posts and articles. No contact details.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Public LinkedIn profile URL or slug.", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.linkedin.com/in/williamhgates" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/linkedin/search/posts": { "get": { "operationId": "linkedinSearchPosts", "summary": "LinkedIn post search (search-engine derived)", "tags": [ "LinkedIn" ], "description": "Built from public search-engine results (DuckDuckGo / Startpage / Brave / Bing, whichever serves a guest) for a site:-restricted query (site:linkedin.com/posts ). The top N posts are hydrated through the public linkedin/post page (text, author, date, counts, comments).\n\nCost: 2 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Search query.", "schema": { "type": "string", "maxLength": 300 } }, { "name": "date_posted", "in": "query", "required": false, "description": "Restrict to results from the last hour/day/week/month/year (search-engine freshness filter; last-hour is treated as last-day).", "schema": { "type": "string", "enum": [ "last-hour", "last-day", "last-week", "last-month", "last-year" ], "maxLength": 512 } }, { "name": "cursor", "in": "query", "required": false, "description": "Page cursor (the `cursor` from a previous response).", "schema": { "type": "string", "maxLength": 8 } }, { "name": "hydrate", "in": "query", "required": false, "description": "SignalShelf extension: how many top results to hydrate through the matching public guest op (default 5, max 10, 0 = search-engine fields only).", "schema": { "type": "integer", "minimum": 0, "maximum": 10 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/linkme": { "get": { "operationId": "linkme", "summary": "Linkme page", "tags": [ "Linkme" ], "description": "Profile, links and social icons of a public Linkme page (link.me, also linkme.bio).\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Linkme page URL.", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://link.me/danucd" }, { "name": "cache_max_age", "in": "query", "required": false, "description": "Accepted for reference-API compatibility; guest fetches are always live.", "schema": { "type": "string", "enum": [ "1d", "3d", "7d", "14d", "30d" ] } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/linktree": { "get": { "operationId": "linktree", "summary": "Linktree page", "tags": [ "Linktree" ], "description": "Profile, links and social icons of a public Linktree page (from the page’s embedded __NEXT_DATA__).\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Linktree page URL.", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://linktr.ee/selenagomez" }, { "name": "cache_max_age", "in": "query", "required": false, "description": "Accepted for reference-API compatibility; guest fetches are always live.", "schema": { "type": "string", "enum": [ "1d", "3d", "7d", "14d", "30d" ] } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/amazon-products": { "get": { "operationId": "outscraperAmazonProducts", "summary": "Outscraper: Amazon products", "tags": [ "Outscraper" ], "description": "Product details per product URL or ASIN (search-result URLs are not supported). Outscraper-compatible (/amazon-products); served by amazon/product. Billed per query at the underlying op's price.\n\nCost: varies (see description) credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Query, or several queries as repeated `query` params (max 10 per call; each query is billed separately).", "schema": { "type": "array", "items": { "type": "string", "maxLength": 2048 }, "maxItems": 25 }, "example": "pizza, New York, NY, USA", "style": "form", "explode": true }, { "name": "async", "in": "query", "required": false, "description": "Outscraper async flag. Accepted and ignored: results are always returned synchronously with status \"Success\".", "schema": { "type": "string", "pattern": "^(?:true|false|True|False|TRUE|FALSE|1|0)$" } }, { "name": "ui", "in": "query", "required": false, "description": "Accepted and ignored.", "schema": { "type": "string", "pattern": "^(?:true|false|True|False|TRUE|FALSE|1|0)$" } }, { "name": "webhook", "in": "query", "required": false, "description": "Callback URL. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated field list. Accepted and ignored: all fields are returned. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "format", "in": "query", "required": false, "description": "Output file format (UI tasks). Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "limit", "in": "query", "required": false, "description": "Accepted (a product URL/ASIN returns one product).", "schema": { "type": "string", "pattern": "^\\d{1,4}$", "maxLength": 4 } }, { "name": "domain", "in": "query", "required": false, "description": "Marketplace for ASIN queries (default amazon.com).", "schema": { "type": "string", "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.es", "amazon.fr", "amazon.it", "amazon.in", "amazon.nl", "amazon.se", "amazon.sa", "amazon.com.mx", "amazon.com.au", "amazon.co.jp", "amazon.com.br", "amazon.ae", "amazon.sg" ] } }, { "name": "postal_code", "in": "query", "required": false, "description": "Delivery postal code. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "language", "in": "query", "required": false, "description": "Language code (default en).", "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{2,12}$", "maxLength": 12 }, "example": "en" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/amazon-reviews": { "get": { "operationId": "outscraperAmazonReviews", "summary": "Outscraper: Amazon reviews", "tags": [ "Outscraper" ], "description": "Top reviews per product URL or ASIN. Outscraper-compatible (/amazon-reviews); served by amazon/reviews. Billed per query at the underlying op's price.\n\nCost: varies (see description) credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Query, or several queries as repeated `query` params (max 10 per call; each query is billed separately).", "schema": { "type": "array", "items": { "type": "string", "maxLength": 2048 }, "maxItems": 25 }, "example": "pizza, New York, NY, USA", "style": "form", "explode": true }, { "name": "async", "in": "query", "required": false, "description": "Outscraper async flag. Accepted and ignored: results are always returned synchronously with status \"Success\".", "schema": { "type": "string", "pattern": "^(?:true|false|True|False|TRUE|FALSE|1|0)$" } }, { "name": "ui", "in": "query", "required": false, "description": "Accepted and ignored.", "schema": { "type": "string", "pattern": "^(?:true|false|True|False|TRUE|FALSE|1|0)$" } }, { "name": "webhook", "in": "query", "required": false, "description": "Callback URL. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated field list. Accepted and ignored: all fields are returned. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "format", "in": "query", "required": false, "description": "Output file format (UI tasks). Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "limit", "in": "query", "required": false, "description": "Reviews per product (default 10; guests see the ~8-13 top reviews).", "schema": { "type": "string", "pattern": "^\\d{1,4}$", "maxLength": 4 } }, { "name": "domain", "in": "query", "required": false, "description": "Marketplace for ASIN queries.", "schema": { "type": "string", "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.es", "amazon.fr", "amazon.it", "amazon.in", "amazon.nl", "amazon.se", "amazon.sa", "amazon.com.mx", "amazon.com.au", "amazon.co.jp", "amazon.com.br", "amazon.ae", "amazon.sg" ] } }, { "name": "sort", "in": "query", "required": false, "description": "Review order (top reviews only). Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "filterByReviewer", "in": "query", "required": false, "description": "Reviewer filter. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "filterByStar", "in": "query", "required": false, "description": "Star filter (applied to the fetched reviews).", "schema": { "type": "string", "enum": [ "all_stars", "five_star", "four_star", "three_star", "two_star", "one_star", "positive", "critical" ] } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/appstore-reviews": { "get": { "operationId": "outscraperAppstoreReviews", "summary": "Outscraper: App Store reviews", "tags": [ "Outscraper" ], "description": "Reviews per app id or apps.apple.com URL. Outscraper-compatible (/appstore-reviews); served by app-store/reviews. Billed per query at the underlying op's price.\n\nCost: varies (see description) credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Query, or several queries as repeated `query` params (max 10 per call; each query is billed separately).", "schema": { "type": "array", "items": { "type": "string", "maxLength": 2048 }, "maxItems": 25 }, "example": "pizza, New York, NY, USA", "style": "form", "explode": true }, { "name": "async", "in": "query", "required": false, "description": "Outscraper async flag. Accepted and ignored: results are always returned synchronously with status \"Success\".", "schema": { "type": "string", "pattern": "^(?:true|false|True|False|TRUE|FALSE|1|0)$" } }, { "name": "ui", "in": "query", "required": false, "description": "Accepted and ignored.", "schema": { "type": "string", "pattern": "^(?:true|false|True|False|TRUE|FALSE|1|0)$" } }, { "name": "webhook", "in": "query", "required": false, "description": "Callback URL. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated field list. Accepted and ignored: all fields are returned. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "format", "in": "query", "required": false, "description": "Output file format (UI tasks). Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "limit", "in": "query", "required": false, "description": "Reviews per app (default 100, max 500; billed per 50).", "schema": { "type": "string", "pattern": "^\\d{1,4}$", "maxLength": 4 } }, { "name": "sort", "in": "query", "required": false, "description": "Review order.", "schema": { "type": "string", "enum": [ "mosthelpful", "mostrecent" ] } }, { "name": "cutoff", "in": "query", "required": false, "description": "Unix timestamp; only items newer than this are returned (applied to the fetched page).", "schema": { "type": "string", "pattern": "^\\d{1,12}$", "maxLength": 12 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/google-search-news": { "get": { "operationId": "outscraperGoogleNews", "summary": "Outscraper: Google News", "tags": [ "Outscraper" ], "description": "News items per query (Google News RSS). Outscraper-compatible (/google-search-news); served by google/news. Billed per query at the underlying op's price.\n\nCost: varies (see description) credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Query, or several queries as repeated `query` params (max 10 per call; each query is billed separately).", "schema": { "type": "array", "items": { "type": "string", "maxLength": 2048 }, "maxItems": 25 }, "example": "pizza, New York, NY, USA", "style": "form", "explode": true }, { "name": "async", "in": "query", "required": false, "description": "Outscraper async flag. Accepted and ignored: results are always returned synchronously with status \"Success\".", "schema": { "type": "string", "pattern": "^(?:true|false|True|False|TRUE|FALSE|1|0)$" } }, { "name": "ui", "in": "query", "required": false, "description": "Accepted and ignored.", "schema": { "type": "string", "pattern": "^(?:true|false|True|False|TRUE|FALSE|1|0)$" } }, { "name": "webhook", "in": "query", "required": false, "description": "Callback URL. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated field list. Accepted and ignored: all fields are returned. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "format", "in": "query", "required": false, "description": "Output file format (UI tasks). Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "pagesPerQuery", "in": "query", "required": false, "description": "Pages per query (10 items per page, max 10 pages).", "schema": { "type": "string", "pattern": "^\\d{1,2}$", "maxLength": 2 } }, { "name": "tbs", "in": "query", "required": false, "description": "Time range.", "schema": { "type": "string", "enum": [ "h", "d", "w", "m", "y" ] } }, { "name": "uule", "in": "query", "required": false, "description": "Encoded location. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "language", "in": "query", "required": false, "description": "Language code (default en).", "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{2,12}$", "maxLength": 12 }, "example": "en" }, { "name": "region", "in": "query", "required": false, "description": "Two-letter country code.", "schema": { "type": "string", "pattern": "^[A-Za-z]{2}$", "maxLength": 2 }, "example": "US" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/google-play-reviews": { "get": { "operationId": "outscraperGooglePlayReviews", "summary": "Outscraper: Google Play reviews", "tags": [ "Outscraper" ], "description": "Reviews per app id or Play URL. Outscraper-compatible (/google-play-reviews); served by google-play/reviews. Billed per query at the underlying op's price.\n\nCost: varies (see description) credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Query, or several queries as repeated `query` params (max 10 per call; each query is billed separately).", "schema": { "type": "array", "items": { "type": "string", "maxLength": 2048 }, "maxItems": 25 }, "example": "pizza, New York, NY, USA", "style": "form", "explode": true }, { "name": "async", "in": "query", "required": false, "description": "Outscraper async flag. Accepted and ignored: results are always returned synchronously with status \"Success\".", "schema": { "type": "string", "pattern": "^(?:true|false|True|False|TRUE|FALSE|1|0)$" } }, { "name": "ui", "in": "query", "required": false, "description": "Accepted and ignored.", "schema": { "type": "string", "pattern": "^(?:true|false|True|False|TRUE|FALSE|1|0)$" } }, { "name": "webhook", "in": "query", "required": false, "description": "Callback URL. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated field list. Accepted and ignored: all fields are returned. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "format", "in": "query", "required": false, "description": "Output file format (UI tasks). Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "limit", "in": "query", "required": false, "description": "Reviews per app (default 100, max 100).", "schema": { "type": "string", "pattern": "^\\d{1,4}$", "maxLength": 4 } }, { "name": "sort", "in": "query", "required": false, "description": "Review order.", "schema": { "type": "string", "enum": [ "most_relevant", "newest", "rating" ] } }, { "name": "rating", "in": "query", "required": false, "description": "Only this star rating (filters the fetched page).", "schema": { "type": "string", "pattern": "^\\d{1,1}$", "maxLength": 1 } }, { "name": "cutoff", "in": "query", "required": false, "description": "Unix timestamp; only items newer than this are returned (applied to the fetched page).", "schema": { "type": "string", "pattern": "^\\d{1,12}$", "maxLength": 12 } }, { "name": "language", "in": "query", "required": false, "description": "Language code (default en).", "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{2,12}$", "maxLength": 12 }, "example": "en" }, { "name": "region", "in": "query", "required": false, "description": "Two-letter country code.", "schema": { "type": "string", "pattern": "^[A-Za-z]{2}$", "maxLength": 2 }, "example": "US" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/google-search": { "get": { "operationId": "outscraperGoogleSearch", "summary": "Outscraper: Google search", "tags": [ "Outscraper" ], "description": "Organic results per query and page. Outscraper-compatible (/google-search); served by google/search. Billed per query at the underlying op's price.\n\nCost: varies (see description) credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Query, or several queries as repeated `query` params (max 10 per call; each query is billed separately).", "schema": { "type": "array", "items": { "type": "string", "maxLength": 2048 }, "maxItems": 25 }, "example": "pizza, New York, NY, USA", "style": "form", "explode": true }, { "name": "async", "in": "query", "required": false, "description": "Outscraper async flag. Accepted and ignored: results are always returned synchronously with status \"Success\".", "schema": { "type": "string", "pattern": "^(?:true|false|True|False|TRUE|FALSE|1|0)$" } }, { "name": "ui", "in": "query", "required": false, "description": "Accepted and ignored.", "schema": { "type": "string", "pattern": "^(?:true|false|True|False|TRUE|FALSE|1|0)$" } }, { "name": "webhook", "in": "query", "required": false, "description": "Callback URL. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated field list. Accepted and ignored: all fields are returned. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "format", "in": "query", "required": false, "description": "Output file format (UI tasks). Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "pagesPerQuery", "in": "query", "required": false, "description": "Pages per query (default 1, max 3).", "schema": { "type": "string", "pattern": "^\\d{1,2}$", "maxLength": 2 } }, { "name": "skip", "in": "query", "required": false, "description": "Skip first N results (multiple of 10).", "schema": { "type": "string", "pattern": "^\\d{1,3}$", "maxLength": 3 } }, { "name": "tbs", "in": "query", "required": false, "description": "Time range.", "schema": { "type": "string", "enum": [ "h", "d", "w", "m", "y" ] } }, { "name": "uule", "in": "query", "required": false, "description": "Encoded location. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "enrichment", "in": "query", "required": false, "description": "Enrichments (not offered). Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "language", "in": "query", "required": false, "description": "Language code (default en).", "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{2,12}$", "maxLength": 12 }, "example": "en" }, { "name": "region", "in": "query", "required": false, "description": "Two-letter country code.", "schema": { "type": "string", "pattern": "^[A-Za-z]{2}$", "maxLength": 2 }, "example": "US" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/google-maps-photos": { "get": { "operationId": "outscraperMapsPhotos", "summary": "Outscraper: Google Maps photos", "tags": [ "Outscraper" ], "description": "Photo URLs of the place panel. Outscraper-compatible (/google-maps-photos); served by google-maps/photos. Billed per query at the underlying op's price.\n\nCost: varies (see description) credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Query, or several queries as repeated `query` params (max 10 per call; each query is billed separately).", "schema": { "type": "array", "items": { "type": "string", "maxLength": 2048 }, "maxItems": 25 }, "example": "pizza, New York, NY, USA", "style": "form", "explode": true }, { "name": "async", "in": "query", "required": false, "description": "Outscraper async flag. Accepted and ignored: results are always returned synchronously with status \"Success\".", "schema": { "type": "string", "pattern": "^(?:true|false|True|False|TRUE|FALSE|1|0)$" } }, { "name": "ui", "in": "query", "required": false, "description": "Accepted and ignored.", "schema": { "type": "string", "pattern": "^(?:true|false|True|False|TRUE|FALSE|1|0)$" } }, { "name": "webhook", "in": "query", "required": false, "description": "Callback URL. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated field list. Accepted and ignored: all fields are returned. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "format", "in": "query", "required": false, "description": "Output file format (UI tasks). Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "photosLimit", "in": "query", "required": false, "description": "Photos per place (default 100; the public place panel exposes ~10).", "schema": { "type": "string", "pattern": "^\\d{1,4}$", "maxLength": 4 } }, { "name": "limit", "in": "query", "required": false, "description": "Places per query (only 1 supported).", "schema": { "type": "string", "pattern": "^\\d{1,3}$", "maxLength": 3 } }, { "name": "tag", "in": "query", "required": false, "description": "Only \"all\" is supported; others are ignored.", "schema": { "type": "string", "enum": [ "all", "latest", "menu", "by_owner" ] } }, { "name": "language", "in": "query", "required": false, "description": "Language code (default en).", "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{2,12}$", "maxLength": 12 }, "example": "en" }, { "name": "region", "in": "query", "required": false, "description": "Two-letter country code.", "schema": { "type": "string", "pattern": "^[A-Za-z]{2}$", "maxLength": 2 }, "example": "US" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/google-maps-reviews": { "get": { "operationId": "outscraperMapsReviews", "summary": "Outscraper: Google Maps reviews", "tags": [ "Outscraper" ], "description": "Place info plus reviews_data[] per place. Outscraper-compatible (/google-maps-reviews); served by google-maps/reviews (count-routed). Billed per query at the underlying op's price.\n\nCost: varies (see description) credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Query, or several queries as repeated `query` params (max 10 per call; each query is billed separately).", "schema": { "type": "array", "items": { "type": "string", "maxLength": 2048 }, "maxItems": 25 }, "example": "pizza, New York, NY, USA", "style": "form", "explode": true }, { "name": "async", "in": "query", "required": false, "description": "Outscraper async flag. Accepted and ignored: results are always returned synchronously with status \"Success\".", "schema": { "type": "string", "pattern": "^(?:true|false|True|False|TRUE|FALSE|1|0)$" } }, { "name": "ui", "in": "query", "required": false, "description": "Accepted and ignored.", "schema": { "type": "string", "pattern": "^(?:true|false|True|False|TRUE|FALSE|1|0)$" } }, { "name": "webhook", "in": "query", "required": false, "description": "Callback URL. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated field list. Accepted and ignored: all fields are returned. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "format", "in": "query", "required": false, "description": "Output file format (UI tasks). Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "reviewsLimit", "in": "query", "required": false, "description": "Reviews per place (default 100, max 100; 0 = 100). ≤5 with default sort uses the free guest path.", "schema": { "type": "string", "pattern": "^\\d{1,4}$", "maxLength": 4 } }, { "name": "limit", "in": "query", "required": false, "description": "Places per text query (default 1, max 5).", "schema": { "type": "string", "pattern": "^\\d{1,3}$", "maxLength": 3 } }, { "name": "sort", "in": "query", "required": false, "description": "Review order.", "schema": { "type": "string", "enum": [ "most_relevant", "newest", "highest_rating", "lowest_rating" ] } }, { "name": "lastPaginationId", "in": "query", "required": false, "description": "Pagination cursor.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "start", "in": "query", "required": false, "description": "Unix timestamp; only reviews older than this.", "schema": { "type": "string", "pattern": "^\\d{1,12}$", "maxLength": 12 } }, { "name": "cutoff", "in": "query", "required": false, "description": "Unix timestamp; only items newer than this are returned (applied to the fetched page).", "schema": { "type": "string", "pattern": "^\\d{1,12}$", "maxLength": 12 } }, { "name": "cutoffRating", "in": "query", "required": false, "description": "With highest_rating: min rating; with lowest_rating: max rating.", "schema": { "type": "string", "pattern": "^\\d{1,1}$", "maxLength": 1 } }, { "name": "ignoreEmpty", "in": "query", "required": false, "description": "Drop reviews without text.", "schema": { "type": "string", "pattern": "^(?:true|false|True|False|TRUE|FALSE|1|0)$" } }, { "name": "reviewsQuery", "in": "query", "required": false, "description": "Review text filter (not supported). Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "source", "in": "query", "required": false, "description": "Review source. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "skip", "in": "query", "required": false, "description": "Accepted and ignored (use lastPaginationId).", "schema": { "type": "string", "pattern": "^\\d{1,5}$", "maxLength": 5 } }, { "name": "coordinates", "in": "query", "required": false, "description": "Coordinates. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "language", "in": "query", "required": false, "description": "Language code (default en).", "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{2,12}$", "maxLength": 12 }, "example": "en" }, { "name": "region", "in": "query", "required": false, "description": "Two-letter country code.", "schema": { "type": "string", "pattern": "^[A-Za-z]{2}$", "maxLength": 2 }, "example": "US" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/google-maps-search": { "get": { "operationId": "outscraperMapsSearch", "summary": "Outscraper: Google Maps search", "tags": [ "Outscraper" ], "description": "Places from Google Maps for each query; place_id / google_id / CID / Maps URL queries return that place. Outscraper-compatible (/google-maps-search); served by google-maps/search (place ids/URLs: google-maps/place). Billed per query at the underlying op's price.\n\nCost: varies (see description) credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Query, or several queries as repeated `query` params (max 10 per call; each query is billed separately).", "schema": { "type": "array", "items": { "type": "string", "maxLength": 2048 }, "maxItems": 25 }, "example": "pizza, New York, NY, USA", "style": "form", "explode": true }, { "name": "async", "in": "query", "required": false, "description": "Outscraper async flag. Accepted and ignored: results are always returned synchronously with status \"Success\".", "schema": { "type": "string", "pattern": "^(?:true|false|True|False|TRUE|FALSE|1|0)$" } }, { "name": "ui", "in": "query", "required": false, "description": "Accepted and ignored.", "schema": { "type": "string", "pattern": "^(?:true|false|True|False|TRUE|FALSE|1|0)$" } }, { "name": "webhook", "in": "query", "required": false, "description": "Callback URL. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated field list. Accepted and ignored: all fields are returned. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "format", "in": "query", "required": false, "description": "Output file format (UI tasks). Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "limit", "in": "query", "required": false, "description": "Places per query (default 20, max 100 here).", "schema": { "type": "string", "pattern": "^\\d{1,4}$", "maxLength": 4 } }, { "name": "organizationsPerQueryLimit", "in": "query", "required": false, "description": "SDK alias of limit.", "schema": { "type": "string", "pattern": "^\\d{1,4}$", "maxLength": 4 } }, { "name": "skipPlaces", "in": "query", "required": false, "description": "Skip first N places (multiple of 20).", "schema": { "type": "string", "pattern": "^\\d{1,4}$", "maxLength": 4 } }, { "name": "skip", "in": "query", "required": false, "description": "Alias of skipPlaces.", "schema": { "type": "string", "pattern": "^\\d{1,4}$", "maxLength": 4 } }, { "name": "dropDuplicates", "in": "query", "required": false, "description": "Drop the same place across queries.", "schema": { "type": "string", "pattern": "^(?:true|false|True|False|TRUE|FALSE|1|0)$" } }, { "name": "totalLimit", "in": "query", "required": false, "description": "Total places across all queries.", "schema": { "type": "string", "pattern": "^\\d{1,5}$", "maxLength": 5 } }, { "name": "coordinates", "in": "query", "required": false, "description": "Accepted and ignored (put the location in the query).", "schema": { "type": "string", "maxLength": 100 } }, { "name": "filters", "in": "query", "required": false, "description": "Quick filters. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "enrichment", "in": "query", "required": false, "description": "Enrichments (not offered). Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "language", "in": "query", "required": false, "description": "Language code (default en).", "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{2,12}$", "maxLength": 12 }, "example": "en" }, { "name": "region", "in": "query", "required": false, "description": "Two-letter country code.", "schema": { "type": "string", "pattern": "^[A-Za-z]{2}$", "maxLength": 2 }, "example": "US" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/tripadvisor-reviews": { "get": { "operationId": "outscraperTripadvisorReviews", "summary": "Outscraper: Tripadvisor reviews", "tags": [ "Outscraper" ], "description": "Latest review snippets per Tripadvisor listing URL. Outscraper-compatible (/tripadvisor-reviews); served by tripadvisor/reviews. Billed per query at the underlying op's price.\n\nCost: varies (see description) credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Query, or several queries as repeated `query` params (max 10 per call; each query is billed separately).", "schema": { "type": "array", "items": { "type": "string", "maxLength": 2048 }, "maxItems": 25 }, "example": "pizza, New York, NY, USA", "style": "form", "explode": true }, { "name": "async", "in": "query", "required": false, "description": "Outscraper async flag. Accepted and ignored: results are always returned synchronously with status \"Success\".", "schema": { "type": "string", "pattern": "^(?:true|false|True|False|TRUE|FALSE|1|0)$" } }, { "name": "ui", "in": "query", "required": false, "description": "Accepted and ignored.", "schema": { "type": "string", "pattern": "^(?:true|false|True|False|TRUE|FALSE|1|0)$" } }, { "name": "webhook", "in": "query", "required": false, "description": "Callback URL. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated field list. Accepted and ignored: all fields are returned. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "format", "in": "query", "required": false, "description": "Output file format (UI tasks). Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "limit", "in": "query", "required": false, "description": "Reviews per listing (default 100; public widgets expose ≤5 snippets).", "schema": { "type": "string", "pattern": "^\\d{1,4}$", "maxLength": 4 } }, { "name": "cutoff", "in": "query", "required": false, "description": "Unix timestamp; only items newer than this are returned (applied to the fetched page).", "schema": { "type": "string", "pattern": "^\\d{1,12}$", "maxLength": 12 } }, { "name": "language", "in": "query", "required": false, "description": "Language code (default en).", "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{2,12}$", "maxLength": 12 }, "example": "en" } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/trustpilot": { "get": { "operationId": "outscraperTrustpilot", "summary": "Outscraper: Trustpilot business", "tags": [ "Outscraper" ], "description": "Business profile per domain or Trustpilot URL. Outscraper-compatible (/trustpilot); served by trustpilot/business. Billed per query at the underlying op's price.\n\nCost: varies (see description) credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Query, or several queries as repeated `query` params (max 10 per call; each query is billed separately).", "schema": { "type": "array", "items": { "type": "string", "maxLength": 2048 }, "maxItems": 25 }, "example": "pizza, New York, NY, USA", "style": "form", "explode": true }, { "name": "async", "in": "query", "required": false, "description": "Outscraper async flag. Accepted and ignored: results are always returned synchronously with status \"Success\".", "schema": { "type": "string", "pattern": "^(?:true|false|True|False|TRUE|FALSE|1|0)$" } }, { "name": "ui", "in": "query", "required": false, "description": "Accepted and ignored.", "schema": { "type": "string", "pattern": "^(?:true|false|True|False|TRUE|FALSE|1|0)$" } }, { "name": "webhook", "in": "query", "required": false, "description": "Callback URL. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated field list. Accepted and ignored: all fields are returned. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "format", "in": "query", "required": false, "description": "Output file format (UI tasks). Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "enrichment", "in": "query", "required": false, "description": "Enrichments (not offered). Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/trustpilot-reviews": { "get": { "operationId": "outscraperTrustpilotReviews", "summary": "Outscraper: Trustpilot reviews", "tags": [ "Outscraper" ], "description": "Latest reviews per domain or Trustpilot URL. Outscraper-compatible (/trustpilot-reviews); served by trustpilot/reviews. Billed per query at the underlying op's price.\n\nCost: varies (see description) credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Query, or several queries as repeated `query` params (max 10 per call; each query is billed separately).", "schema": { "type": "array", "items": { "type": "string", "maxLength": 2048 }, "maxItems": 25 }, "example": "pizza, New York, NY, USA", "style": "form", "explode": true }, { "name": "async", "in": "query", "required": false, "description": "Outscraper async flag. Accepted and ignored: results are always returned synchronously with status \"Success\".", "schema": { "type": "string", "pattern": "^(?:true|false|True|False|TRUE|FALSE|1|0)$" } }, { "name": "ui", "in": "query", "required": false, "description": "Accepted and ignored.", "schema": { "type": "string", "pattern": "^(?:true|false|True|False|TRUE|FALSE|1|0)$" } }, { "name": "webhook", "in": "query", "required": false, "description": "Callback URL. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated field list. Accepted and ignored: all fields are returned. Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "format", "in": "query", "required": false, "description": "Output file format (UI tasks). Accepted and ignored: results are always returned synchronously.", "schema": { "type": "string", "maxLength": 2048 } }, { "name": "limit", "in": "query", "required": false, "description": "Reviews per business (default 100, max 100).", "schema": { "type": "string", "pattern": "^\\d{1,4}$", "maxLength": 4 } }, { "name": "skip", "in": "query", "required": false, "description": "Skip first N reviews.", "schema": { "type": "string", "pattern": "^\\d{1,3}$", "maxLength": 3 } }, { "name": "languages", "in": "query", "required": false, "description": "default | all | language code.", "schema": { "type": "string", "maxLength": 64 } }, { "name": "sort", "in": "query", "required": false, "description": "Only \"recency\" (the default order) is supported.", "schema": { "type": "string", "maxLength": 20 } }, { "name": "cutoff", "in": "query", "required": false, "description": "Unix timestamp; only items newer than this are returned (applied to the fetched page).", "schema": { "type": "string", "pattern": "^\\d{1,12}$", "maxLength": 12 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/pillar": { "get": { "operationId": "pillar", "summary": "Pillar page", "tags": [ "Pillar" ], "description": "Profile, links, products and socials of a public Pillar creator store page.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Pillar page URL.", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://pillar.io/jasonderulo" }, { "name": "cache_max_age", "in": "query", "required": false, "description": "Accepted for reference-API compatibility; guest fetches are always live.", "schema": { "type": "string", "enum": [ "1d", "3d", "7d", "14d", "30d" ] } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/pinterest/board": { "get": { "operationId": "pinterestBoard", "summary": "Read a public Pinterest board and its pins", "tags": [ "Pinterest" ], "description": "Board metadata (BoardResource) plus a page of its pins (BoardFeedResource).\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Public board URL https://www.pinterest.com///.", "schema": { "type": "string", "maxLength": 2048 }, "example": "https://www.pinterest.com/marthastewart/letscelebrate-pin-party/" }, { "name": "trim", "in": "query", "required": false, "description": "Return a slimmer object (one image URL, no nested owner/board details).", "schema": { "type": "boolean" } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque bookmark returned as `cursor` by the previous page.", "schema": { "type": "string", "maxLength": 4096 } } ], "responses": { "200": { "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid parameters. No credits charged." }, "404": { "description": "Not found or private. No credits charged." }, "429": { "description": "Rate limited." }, "502": { "description": "Upstream failed after retries. No credits charged." } } } }, "/v1/pinterest/pin": { "get": { "operationId": "pinterestPin", "summary": "Read a public Pinterest pin", "tags": [ "Pinterest" ], "description": "Pin details (title, description, outbound link, images/video, saves, comments count, pinner, board) from the public PinResource. Accepts pinterest.com/pin// URLs or pin.it short links.\n\nCost: 1 credit(s) per successful call. Failed calls are free.", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Public pin URL (https://www.pinterest.com/pin// or https://pin.it/

).",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://www.pinterest.com/pin/32088216070249861/"
          },
          {
            "name": "trim",
            "in": "query",
            "required": false,
            "description": "Return a slimmer object (one image URL, no nested owner/board details).",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "cache_max_age",
            "in": "query",
            "required": false,
            "description": "Accepted for compatibility; guest reads are always live.",
            "schema": {
              "type": "string",
              "enum": [
                "1d",
                "3d",
                "7d",
                "14d",
                "30d"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/pinterest/search": {
      "get": {
        "operationId": "pinterestSearch",
        "summary": "Search public Pinterest pins",
        "tags": [
          "Pinterest"
        ],
        "description": "Logged-out Pinterest pin search (BaseSearchResource). Guest results carry opaque pin ids (e1_…) that only resolve while logged in, so use the returned fields rather than re-fetching each pin.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "Search keywords.",
            "schema": {
              "type": "string",
              "maxLength": 200
            },
            "example": "home decor"
          },
          {
            "name": "trim",
            "in": "query",
            "required": false,
            "description": "Return a slimmer object (one image URL, no nested owner/board details).",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "Opaque bookmark returned as `cursor` by the previous page.",
            "schema": {
              "type": "string",
              "maxLength": 4096
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/pinterest/topic": {
      "get": {
        "operationId": "pinterestTopic",
        "summary": "Read a public Pinterest topic (ideas) page",
        "tags": [
          "Pinterest"
        ],
        "description": "Topic metadata, related interests and its best pins from a public /ideas/// page (InterestResource + BestPinsFeedAltResource).\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Public topic URL https://www.pinterest.com/ideas///.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://www.pinterest.com/ideas/art/961238559656/"
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/pinterest/user/boards": {
      "get": {
        "operationId": "pinterestUserBoards",
        "summary": "List a Pinterest user’s public boards",
        "tags": [
          "Pinterest"
        ],
        "description": "Public boards of a Pinterest profile (BoardsResource), with pin/follower counts.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "Pinterest username (no @, no URL).",
            "schema": {
              "type": "string",
              "pattern": "^[A-Za-z0-9_.-]{1,100}$",
              "maxLength": 100
            },
            "example": "marthastewart"
          },
          {
            "name": "trim",
            "in": "query",
            "required": false,
            "description": "Return a slimmer object (one image URL, no nested owner/board details).",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "Opaque bookmark returned as `cursor` by the previous page.",
            "schema": {
              "type": "string",
              "maxLength": 4096
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/reddit/post/transcript": {
      "get": {
        "operationId": "redditPostTranscript",
        "summary": "Transcript of a Reddit-hosted video",
        "tags": [
          "Reddit"
        ],
        "description": "Reads the WebVTT captions Reddit publishes for v.redd.it videos (auto-generated, English; transcript_source \"auto\"). Without captions, runs speech-to-text on the v.redd.it DASH audio track (transcript_source \"ai\"). Videos with neither return 404.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Reddit post URL with a Reddit-hosted video.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://www.reddit.com/r/nextfuckinglevel/comments/1xg8vle/second_woman_to_ever_lift_the_dinnie_stones_side/"
          },
          {
            "name": "language",
            "in": "query",
            "required": false,
            "description": "Reddit captions are English only; any other language skips captions and is used as the speech-to-text language hint.",
            "schema": {
              "type": "string",
              "maxLength": 10
            }
          },
          {
            "name": "allow_long_transcription",
            "in": "query",
            "required": false,
            "description": "Speech-to-text fallback: transcribe up to 10 min instead of the first 2 min.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "cache_max_age",
            "in": "query",
            "required": false,
            "description": "Accepted for reference-API compatibility; guest reads are always live.",
            "schema": {
              "type": "string",
              "enum": [
                "1d",
                "3d",
                "7d",
                "14d",
                "30d"
              ],
              "maxLength": 2048
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/reddit/subreddit": {
      "get": {
        "operationId": "redditSubreddit",
        "summary": "List posts in a public subreddit",
        "tags": [
          "Reddit"
        ],
        "description": "Public subreddit feed (Reddit RSS): newest/hot/top posts with title, author, permalink, link, self-text and thumbnail. Score and comment counts are not published in the feed (null). ~25 per page; paginate with after.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "subreddit",
            "in": "query",
            "required": true,
            "description": "Subreddit name without r/ (URL accepted).",
            "schema": {
              "type": "string",
              "maxLength": 64
            },
            "example": "technology"
          },
          {
            "name": "sort",
            "in": "query",
            "required": false,
            "description": "hot (default), new, top, rising or controversial.",
            "schema": {
              "type": "string",
              "enum": [
                "hot",
                "new",
                "top",
                "rising",
                "controversial"
              ]
            }
          },
          {
            "name": "timeframe",
            "in": "query",
            "required": false,
            "description": "For top/controversial: hour, day, week, month, year, all.",
            "schema": {
              "type": "string",
              "enum": [
                "hour",
                "day",
                "week",
                "month",
                "year",
                "all"
              ]
            }
          },
          {
            "name": "after",
            "in": "query",
            "required": false,
            "description": "Cursor from a previous page (the \"after\" value).",
            "schema": {
              "type": "string",
              "pattern": "^t3_[a-z0-9]+$",
              "maxLength": 20
            }
          },
          {
            "name": "trim",
            "in": "query",
            "required": false,
            "description": "Drop selftext_html to shrink the response.",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/rumble/channel/videos": {
      "get": {
        "operationId": "rumbleChannelVideos",
        "summary": "List a Rumble channel's videos",
        "tags": [
          "Rumble"
        ],
        "description": "Public videos from a Rumble channel or user page, newest first, 25 per page.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": false,
            "description": "Channel name as in rumble.com/c/.",
            "schema": {
              "type": "string",
              "maxLength": 100
            },
            "example": "russellbrand"
          },
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "Channel URL (rumble.com/c/ or /user/). Either handle or url is required.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://rumble.com/c/russellbrand"
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "Page number from a previous response.",
            "schema": {
              "type": "string",
              "maxLength": 6
            },
            "example": "2"
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/rumble/search": {
      "get": {
        "operationId": "rumbleSearch",
        "summary": "Search Rumble videos",
        "tags": [
          "Rumble"
        ],
        "description": "Logged-out Rumble video search results (title, channel, views, votes, duration, date). Page-number cursor.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "Search keywords.",
            "schema": {
              "type": "string",
              "maxLength": 200
            },
            "example": "news"
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "Page number from a previous response.",
            "schema": {
              "type": "string",
              "maxLength": 6
            },
            "example": "2"
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/rumble/video": {
      "get": {
        "operationId": "rumbleVideo",
        "summary": "Get a Rumble video",
        "tags": [
          "Rumble"
        ],
        "description": "Public Rumble video details: title, description, channel, views, likes/dislikes, duration, captions available.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Rumble video URL.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://rumble.com/v7h6wm6-the-devil-is-closer-than-you-think-sf767.html"
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/rumble/video/comments": {
      "get": {
        "operationId": "rumbleVideoComments",
        "summary": "Get Rumble video comments",
        "tags": [
          "Rumble"
        ],
        "description": "Public comments (and inline replies) Rumble renders for a video, with likes, reply counts and timestamps.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Rumble video URL.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://rumble.com/v7h6wm6-the-devil-is-closer-than-you-think-sf767.html"
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/rumble/video/transcript": {
      "get": {
        "operationId": "rumbleVideoTranscript",
        "summary": "Get a Rumble video transcript",
        "tags": [
          "Rumble"
        ],
        "description": "Transcript from the video's public captions (Rumble auto/creator captions, WebVTT; transcript_source \"auto\"/\"creator\"). Without captions, runs speech-to-text on the smallest MP4 from the embed JSON (transcript_source \"ai\"); transcript null with needs_asr=true only when speech-to-text is unavailable.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Rumble video URL.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://rumble.com/v7h6wm6-the-devil-is-closer-than-you-think-sf767.html"
          },
          {
            "name": "language",
            "in": "query",
            "required": false,
            "description": "Preferred caption language code (e.g. en). Defaults to the first available track. Also the speech-to-text language hint.",
            "schema": {
              "type": "string",
              "maxLength": 20
            },
            "example": "en"
          },
          {
            "name": "allow_long_transcription",
            "in": "query",
            "required": false,
            "description": "Speech-to-text fallback: transcribe up to 10 min instead of the first 2 min.",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/snapchat/spotlight/comments": {
      "get": {
        "operationId": "snapchatSpotlightComments",
        "summary": "Get Snapchat Spotlight comments",
        "tags": [
          "Snapchat"
        ],
        "description": "Public comments on a Snapchat Spotlight snap, as shown on snapchat.com when logged out. Cursor-paginated (25 per page).\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Snapchat Spotlight URL.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://www.snapchat.com/spotlight/W7_EDlXWTBiXAEEniNoMPwAAYa2ZweGhmenduAaGAk_nWAaGAk7ybAAAAAA"
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "Cursor from a previous response.",
            "schema": {
              "type": "string",
              "maxLength": 4000
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/soundcloud/artist": {
      "get": {
        "operationId": "soundcloudArtist",
        "summary": "SoundCloud artist profile",
        "tags": [
          "SoundCloud"
        ],
        "description": "Public SoundCloud profile (followers, track/playlist counts, verification, city, web profiles) via the public web client_id and api-v2 resolve, as a logged-out guest.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": false,
            "description": "SoundCloud permalink (the part after soundcloud.com/). Provide handle or url.",
            "schema": {
              "type": "string",
              "maxLength": 100
            },
            "example": "octobersveryown"
          },
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "SoundCloud profile URL. Provide handle or url.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://soundcloud.com/octobersveryown"
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/soundcloud/artist/tracks": {
      "get": {
        "operationId": "soundcloudArtistTracks",
        "summary": "SoundCloud artist tracks",
        "tags": [
          "SoundCloud"
        ],
        "description": "Public tracks of a SoundCloud profile, newest first, with play/like/repost/comment counts. Paginate with cursor.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": false,
            "description": "SoundCloud permalink (the part after soundcloud.com/). Provide handle or url.",
            "schema": {
              "type": "string",
              "maxLength": 100
            },
            "example": "octobersveryown"
          },
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "SoundCloud profile URL. Provide handle or url.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://soundcloud.com/octobersveryown"
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "Opaque cursor from a previous response.",
            "schema": {
              "type": "string",
              "maxLength": 500
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/soundcloud/track": {
      "get": {
        "operationId": "soundcloudTrack",
        "summary": "SoundCloud track",
        "tags": [
          "SoundCloud"
        ],
        "description": "Public SoundCloud track metadata and counts by URL.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Public SoundCloud track URL.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://soundcloud.com/forss/flickermood"
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/spotify/album": {
      "get": {
        "operationId": "spotifyAlbum",
        "summary": "Spotify album (guest)",
        "tags": [
          "Spotify"
        ],
        "description": "Public album metadata and track list with per-track play counts.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": false,
            "description": "Spotify album ID (22 characters). Provide id or url.",
            "schema": {
              "type": "string",
              "pattern": "^[A-Za-z0-9]{22}$",
              "maxLength": 64
            }
          },
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "Public open.spotify.com album URL or spotify:album: URI. Provide id or url.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://open.spotify.com/album/1NAmidJlEaVgA3MpcPFYGq"
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/spotify/artist": {
      "get": {
        "operationId": "spotifyArtist",
        "summary": "Spotify artist profile (guest)",
        "tags": [
          "Spotify"
        ],
        "description": "Public artist page data as a logged-out guest: name, verification, followers, monthly listeners, world rank, top cities, biography, top tracks, recent releases and related artists.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": false,
            "description": "Spotify artist ID (22 characters). Provide id or url.",
            "schema": {
              "type": "string",
              "pattern": "^[A-Za-z0-9]{22}$",
              "maxLength": 64
            }
          },
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "Public open.spotify.com artist URL or spotify:artist: URI. Provide id or url.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://open.spotify.com/artist/06HL4z0CvFAxyc27GXpf02"
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/spotify/playlist": {
      "get": {
        "operationId": "spotifyPlaylist",
        "summary": "Spotify playlist (guest)",
        "tags": [
          "Spotify"
        ],
        "description": "Public playlist metadata, follower count and a page of tracks (100 per page). Use cursor for the next page.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": false,
            "description": "Spotify playlist ID (22 characters). Provide id or url.",
            "schema": {
              "type": "string",
              "pattern": "^[A-Za-z0-9]{22}$",
              "maxLength": 64
            }
          },
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "Public open.spotify.com playlist URL or spotify:playlist: URI. Provide id or url.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://open.spotify.com/playlist/37i9dQZF1DXcBWIGoYBM5M"
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "Pagination cursor (track offset) from a previous response.",
            "schema": {
              "type": "string",
              "pattern": "^\\d{1,6}$",
              "maxLength": 10
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/spotify/podcast": {
      "get": {
        "operationId": "spotifyPodcast",
        "summary": "Spotify podcast (guest)",
        "tags": [
          "Spotify"
        ],
        "description": "Public podcast (show) metadata: name, publisher, description, rating, episode count.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": false,
            "description": "Spotify show ID (22 characters). Provide id or url.",
            "schema": {
              "type": "string",
              "pattern": "^[A-Za-z0-9]{22}$",
              "maxLength": 64
            }
          },
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "Public open.spotify.com show URL or spotify:show: URI. Provide id or url.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://open.spotify.com/show/4rOoJ6Egrf8K2IrywzwOMk"
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/spotify/podcast/episodes": {
      "get": {
        "operationId": "spotifyPodcastEpisodes",
        "summary": "Spotify podcast episodes (guest)",
        "tags": [
          "Spotify"
        ],
        "description": "Public episode list of a podcast (newest first, 50 per page). Use cursor (offset) for the next page.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": false,
            "description": "Spotify show ID (22 characters). Provide id or url.",
            "schema": {
              "type": "string",
              "pattern": "^[A-Za-z0-9]{22}$",
              "maxLength": 64
            }
          },
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "Public open.spotify.com show URL or spotify:show: URI. Provide id or url.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://open.spotify.com/show/4rOoJ6Egrf8K2IrywzwOMk"
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "Pagination cursor (episode offset) from a previous response.",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "maximum": 100000
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/spotify/search": {
      "get": {
        "operationId": "spotifySearch",
        "summary": "Spotify search (guest)",
        "tags": [
          "Spotify"
        ],
        "description": "Searches Spotify as a logged-out guest and returns top tracks, artists, albums, playlists, podcasts and episodes.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "Search text.",
            "schema": {
              "type": "string",
              "maxLength": 200
            },
            "example": "taylor swift"
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/spotify/track": {
      "get": {
        "operationId": "spotifyTrack",
        "summary": "Spotify track (guest)",
        "tags": [
          "Spotify"
        ],
        "description": "Public track metadata: name, artists, album, duration, play count, explicit flag, release date.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": false,
            "description": "Spotify track ID (22 characters). Provide id or url.",
            "schema": {
              "type": "string",
              "pattern": "^[A-Za-z0-9]{22}$",
              "maxLength": 64
            }
          },
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "Public open.spotify.com track URL or spotify:track: URI. Provide id or url.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://open.spotify.com/track/4cOdK2wGLETKBW3PvgPWqT"
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/telegram/channel": {
      "get": {
        "operationId": "telegramChannel",
        "summary": "Read a public Telegram channel",
        "tags": [
          "Telegram"
        ],
        "description": "Public t.me web preview: title, description, avatar, subscriber and media counters.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "Channel username without @ (t.me URL accepted).",
            "schema": {
              "type": "string",
              "maxLength": 64
            },
            "example": "durov"
          },
          {
            "name": "cache_max_age",
            "in": "query",
            "required": false,
            "description": "Accepted for reference-API compatibility; guest reads are always live.",
            "schema": {
              "type": "string",
              "enum": [
                "1d",
                "3d",
                "7d",
                "14d",
                "30d"
              ],
              "maxLength": 2048
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/telegram/channel/posts": {
      "get": {
        "operationId": "telegramChannelPosts",
        "summary": "List public Telegram channel posts",
        "tags": [
          "Telegram"
        ],
        "description": "Public t.me/s/ preview, newest first, ~20 per page; cursor = before-id.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "Channel username without @.",
            "schema": {
              "type": "string",
              "maxLength": 64
            },
            "example": "durov"
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "Return posts with id lower than this (from a previous next_cursor).",
            "schema": {
              "type": "string",
              "pattern": "^[0-9]+$",
              "maxLength": 20
            }
          },
          {
            "name": "cache_max_age",
            "in": "query",
            "required": false,
            "description": "Accepted for reference-API compatibility; guest reads are always live.",
            "schema": {
              "type": "string",
              "enum": [
                "1d",
                "3d",
                "7d",
                "14d",
                "30d"
              ],
              "maxLength": 2048
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/telegram/post": {
      "get": {
        "operationId": "telegramPost",
        "summary": "Read one public Telegram channel post",
        "tags": [
          "Telegram"
        ],
        "description": "Public t.me//?embed=1 widget.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Post URL, e.g. https://t.me/durov/400.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://t.me/durov/400"
          },
          {
            "name": "cache_max_age",
            "in": "query",
            "required": false,
            "description": "Accepted for reference-API compatibility; guest reads are always live.",
            "schema": {
              "type": "string",
              "enum": [
                "1d",
                "3d",
                "7d",
                "14d",
                "30d"
              ],
              "maxLength": 2048
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/threads/post": {
      "get": {
        "operationId": "threadsPost",
        "summary": "Public Threads post (guest)",
        "tags": [
          "Threads"
        ],
        "description": "A public Threads post with its visible direct replies.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "threads.com / threads.net post URL.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://www.threads.com/@natgeo/post/DfQPPDvFJok"
          },
          {
            "name": "trim",
            "in": "query",
            "required": false,
            "description": "Return a slimmer object (drops carousel/tag/coauthor arrays).",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "cache_max_age",
            "in": "query",
            "required": false,
            "description": "Upstream cache hint. Accepted for compatibility and ignored (guest source).",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/threads/profile": {
      "get": {
        "operationId": "threadsProfile",
        "summary": "Public Threads profile (guest)",
        "tags": [
          "Threads"
        ],
        "description": "Logged-out Threads profile: bio, links, follower count, verification, plus the latest posts preview.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "Public Threads username (without @).",
            "schema": {
              "type": "string",
              "pattern": "^@?[A-Za-z0-9._]{1,30}$",
              "maxLength": 30
            },
            "example": "virat.kohli"
          },
          {
            "name": "cache_max_age",
            "in": "query",
            "required": false,
            "description": "Upstream cache hint. Accepted for compatibility and ignored (guest source).",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/threads/search": {
      "get": {
        "operationId": "threadsSearch",
        "summary": "Search Threads posts (guest)",
        "tags": [
          "Threads"
        ],
        "description": "Logged-out Threads keyword search (top results). start_date/end_date (YYYY-MM-DD) filter the returned results.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "Search keywords.",
            "schema": {
              "type": "string",
              "maxLength": 200
            },
            "example": "nasa"
          },
          {
            "name": "start_date",
            "in": "query",
            "required": false,
            "description": "Keep posts on/after this date (UTC).",
            "schema": {
              "type": "string",
              "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
            }
          },
          {
            "name": "end_date",
            "in": "query",
            "required": false,
            "description": "Keep posts on/before this date (UTC).",
            "schema": {
              "type": "string",
              "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
            }
          },
          {
            "name": "trim",
            "in": "query",
            "required": false,
            "description": "Return a slimmer object (drops carousel/tag/coauthor arrays).",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/threads/search/users": {
      "get": {
        "operationId": "threadsSearchUsers",
        "summary": "Search Threads users (guest)",
        "tags": [
          "Threads"
        ],
        "description": "Logged-out Threads account search (typeahead), up to 10 profiles.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "Name or username.",
            "schema": {
              "type": "string",
              "maxLength": 100
            },
            "example": "nasa"
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/threads/user/posts": {
      "get": {
        "operationId": "threadsUserPosts",
        "summary": "Public Threads posts (guest)",
        "tags": [
          "Threads"
        ],
        "description": "Latest top-level threads by a public profile, with cursor pagination.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "Public Threads username (without @).",
            "schema": {
              "type": "string",
              "pattern": "^@?[A-Za-z0-9._]{1,30}$",
              "maxLength": 30
            },
            "example": "virat.kohli"
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "Cursor from a previous page.",
            "schema": {
              "type": "string",
              "maxLength": 4096
            }
          },
          {
            "name": "trim",
            "in": "query",
            "required": false,
            "description": "Return a slimmer object (drops carousel/tag/coauthor arrays).",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/tiktok/ad-library/ad": {
      "get": {
        "operationId": "tiktokAdLibraryAd",
        "summary": "Get one ad from TikTok's public Ad Library",
        "tags": [
          "TikTok"
        ],
        "description": "Ad, advertiser and targeting summary from library.tiktok.com/ads/detail/?ad_id=… .\n\nCost: 2 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "ad_id",
            "in": "query",
            "required": true,
            "description": "TikTok ad library ID.",
            "schema": {
              "type": "string",
              "pattern": "^\\d{6,25}$",
              "maxLength": 512
            },
            "example": "1880398616261842"
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/tiktok/ad-library/search": {
      "get": {
        "operationId": "tiktokAdLibrarySearch",
        "summary": "Search TikTok's public Ad Library (library.tiktok.com)",
        "tags": [
          "TikTok"
        ],
        "description": "Logged-out search of library.tiktok.com (ads shown in the EU/EEA, UK, CH, TR). Defaults to the trailing 365 days.\n\nCost: 2 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": false,
            "description": "Keyword search.",
            "schema": {
              "type": "string",
              "maxLength": 512
            },
            "example": "nike"
          },
          {
            "name": "advertiser_name",
            "in": "query",
            "required": false,
            "description": "Advertiser-name search.",
            "schema": {
              "type": "string",
              "maxLength": 512
            }
          },
          {
            "name": "adv_biz_ids",
            "in": "query",
            "required": false,
            "description": "Comma-separated TikTok advertiser business IDs.",
            "schema": {
              "type": "string",
              "pattern": "^[0-9,]+$",
              "maxLength": 512
            }
          },
          {
            "name": "region",
            "in": "query",
            "required": false,
            "description": "ISO alpha-2 region the ad was shown in, or all (default).",
            "schema": {
              "type": "string",
              "maxLength": 512
            }
          },
          {
            "name": "start_date",
            "in": "query",
            "required": false,
            "description": "YYYY-MM-DD (default: 365 days ago).",
            "schema": {
              "type": "string",
              "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
              "maxLength": 512
            }
          },
          {
            "name": "end_date",
            "in": "query",
            "required": false,
            "description": "YYYY-MM-DD (default: today).",
            "schema": {
              "type": "string",
              "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
              "maxLength": 512
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "Opaque pagination cursor returned by the previous page.",
            "schema": {
              "type": "string",
              "maxLength": 4096
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/tiktok/collection/videos": {
      "get": {
        "operationId": "tiktokCollectionVideos",
        "summary": "Videos in a public TikTok collection or playlist",
        "tags": [
          "TikTok"
        ],
        "description": "Public collection (/collection/-) or playlist (/playlist/-) items, called from inside a tiktok.com page. Paginate with cursor.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Collection/playlist URL or bare collection ID.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "7394627756635573022"
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "Pagination cursor from the previous response.",
            "schema": {
              "type": "string",
              "maxLength": 4096
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/tiktok/get-trending-feed": {
      "get": {
        "operationId": "tiktokGetTrendingFeed",
        "summary": "TikTok trending (For You) feed",
        "tags": [
          "TikTok"
        ],
        "description": "Logged-out For You feed, fetched from a guest session that exits in `region`.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "region",
            "in": "query",
            "required": true,
            "description": "ISO-3166 alpha-2 country. Where it matters the guest session exits from this country.",
            "schema": {
              "type": "string",
              "maxLength": 2
            },
            "example": "US"
          },
          {
            "name": "trim",
            "in": "query",
            "required": false,
            "description": "Accepted for compatibility; responses are always normalized.",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/tiktok/live": {
      "get": {
        "operationId": "tiktokLive",
        "summary": "TikTok live room info",
        "tags": [
          "TikTok"
        ],
        "description": "Public live room info (title, status, viewers, owner, stream URLs) from the public webcast room API.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "room_id",
            "in": "query",
            "required": true,
            "description": "Numeric live room ID.",
            "schema": {
              "type": "string",
              "pattern": "^\\d{1,30}$",
              "maxLength": 30
            },
            "example": "7693676830666705678"
          },
          {
            "name": "user_id",
            "in": "query",
            "required": false,
            "description": "Accepted for compatibility.",
            "schema": {
              "type": "string",
              "maxLength": 30
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/tiktok/profile": {
      "get": {
        "operationId": "tiktokProfile",
        "summary": "Public TikTok profile by handle",
        "tags": [
          "TikTok"
        ],
        "description": "Any public handle. Reads the logged-out profile page (server-rendered user detail). Private accounts return their public header only.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": false,
            "description": "Public TikTok handle without @ (an @handle or profile URL is also accepted).",
            "schema": {
              "type": "string",
              "maxLength": 120
            },
            "example": "nasa"
          },
          {
            "name": "user_id",
            "in": "query",
            "required": false,
            "description": "Numeric user ID. Guest mode needs the handle; user_id alone is rejected.",
            "schema": {
              "type": "string",
              "maxLength": 30
            }
          },
          {
            "name": "cache_max_age",
            "in": "query",
            "required": false,
            "description": "Ignored (no cache in guest mode).",
            "schema": {
              "type": "string",
              "maxLength": 256
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v3/tiktok/profile/videos": {
      "get": {
        "operationId": "tiktokProfileVideos",
        "summary": "Public videos of a TikTok profile",
        "tags": [
          "TikTok"
        ],
        "description": "Newest-first public posts via the web creator item list, called from inside a real profile page. Paginate with max_cursor (millisecond timestamp). sort_by=popular is not supported by this source.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "Public TikTok handle without @ (an @handle or profile URL is also accepted).",
            "schema": {
              "type": "string",
              "maxLength": 120
            },
            "example": "nasa"
          },
          {
            "name": "user_id",
            "in": "query",
            "required": false,
            "description": "Ignored; the handle is resolved on the page.",
            "schema": {
              "type": "string",
              "maxLength": 256
            }
          },
          {
            "name": "sort_by",
            "in": "query",
            "required": false,
            "description": "Only \"latest\" is supported.",
            "schema": {
              "type": "string",
              "enum": [
                "latest",
                "popular"
              ],
              "maxLength": 256
            },
            "example": "latest"
          },
          {
            "name": "region",
            "in": "query",
            "required": false,
            "description": "ISO-3166 alpha-2 country. Where it matters the guest session exits from this country.",
            "schema": {
              "type": "string",
              "maxLength": 2
            },
            "example": "US"
          },
          {
            "name": "include_pinned",
            "in": "query",
            "required": false,
            "description": "Accepted; pinned posts appear in date order.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "trim",
            "in": "query",
            "required": false,
            "description": "Accepted for compatibility; responses are always normalized.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "max_cursor",
            "in": "query",
            "required": false,
            "description": "Cursor (ms timestamp) from the previous page.",
            "schema": {
              "type": "string",
              "pattern": "^\\d{0,20}$",
              "maxLength": 20
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/tiktok/search/hashtag": {
      "get": {
        "operationId": "tiktokSearchHashtag",
        "summary": "Videos for a TikTok hashtag",
        "tags": [
          "TikTok"
        ],
        "description": "Partial: hashtag info plus the public hashtag embed video list (one page, no pagination).\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "hashtag",
            "in": "query",
            "required": true,
            "description": "Hashtag without #.",
            "schema": {
              "type": "string",
              "maxLength": 100
            },
            "example": "space"
          },
          {
            "name": "region",
            "in": "query",
            "required": false,
            "description": "ISO-3166 alpha-2 country. Where it matters the guest session exits from this country.",
            "schema": {
              "type": "string",
              "maxLength": 2
            },
            "example": "US"
          },
          {
            "name": "trim",
            "in": "query",
            "required": false,
            "description": "Accepted for compatibility; responses are always normalized.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "Pagination cursor from the previous response.",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "maximum": 1000000000000000
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/tiktok/search/keyword": {
      "get": {
        "operationId": "tiktokSearchKeyword",
        "summary": "Search TikTok videos by keyword",
        "tags": [
          "TikTok"
        ],
        "description": "Partial: uses TikTok's public SEO \"discover\" keyword page (/discover/) and its video list. Works for keywords TikTok has a discover page for; ranking is TikTok's discover ranking, date_posted/sort_by filters are not supported.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "Search phrase.",
            "schema": {
              "type": "string",
              "maxLength": 200
            },
            "example": "nasa"
          },
          {
            "name": "date_posted",
            "in": "query",
            "required": false,
            "description": "Not supported.",
            "schema": {
              "type": "string",
              "maxLength": 256
            }
          },
          {
            "name": "sort_by",
            "in": "query",
            "required": false,
            "description": "Not supported.",
            "schema": {
              "type": "string",
              "maxLength": 256
            }
          },
          {
            "name": "region",
            "in": "query",
            "required": false,
            "description": "ISO-3166 alpha-2 country. Where it matters the guest session exits from this country.",
            "schema": {
              "type": "string",
              "maxLength": 2
            },
            "example": "US"
          },
          {
            "name": "trim",
            "in": "query",
            "required": false,
            "description": "Accepted for compatibility; responses are always normalized.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "Pagination cursor from the previous response.",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "maximum": 1000000000000000
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/tiktok/search/suggestions": {
      "get": {
        "operationId": "tiktokSearchSuggestions",
        "summary": "TikTok search autocomplete",
        "tags": [
          "TikTok"
        ],
        "description": "Search suggestions as shown in the logged-out search box.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "Search phrase.",
            "schema": {
              "type": "string",
              "maxLength": 200
            },
            "example": "nasa"
          },
          {
            "name": "region",
            "in": "query",
            "required": false,
            "description": "ISO-3166 alpha-2 country. Where it matters the guest session exits from this country.",
            "schema": {
              "type": "string",
              "maxLength": 2
            },
            "example": "US"
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/tiktok/search/top": {
      "get": {
        "operationId": "tiktokSearchTop",
        "summary": "Top TikTok search results",
        "tags": [
          "TikTok"
        ],
        "description": "Partial: same public discover-page source as search/keyword (videos only, no users/sounds blocks).\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "Search phrase.",
            "schema": {
              "type": "string",
              "maxLength": 200
            },
            "example": "nasa"
          },
          {
            "name": "publish_time",
            "in": "query",
            "required": false,
            "description": "Not supported.",
            "schema": {
              "type": "string",
              "maxLength": 256
            }
          },
          {
            "name": "sort_by",
            "in": "query",
            "required": false,
            "description": "Not supported.",
            "schema": {
              "type": "string",
              "maxLength": 256
            }
          },
          {
            "name": "region",
            "in": "query",
            "required": false,
            "description": "ISO-3166 alpha-2 country. Where it matters the guest session exits from this country.",
            "schema": {
              "type": "string",
              "maxLength": 2
            },
            "example": "US"
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "Pagination cursor from the previous response.",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "maximum": 1000000000000000
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/tiktok/search/users": {
      "get": {
        "operationId": "tiktokSearchUsers",
        "summary": "TikTok user search (search-engine derived)",
        "tags": [
          "TikTok"
        ],
        "description": "Built from public search-engine results (DuckDuckGo / Startpage / Brave / Bing, whichever serves a guest) for a site:-restricted query (site:tiktok.com  profile URLs). The top N handles are hydrated through the public tiktok/profile page.\n\nCost: 2 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "Search query.",
            "schema": {
              "type": "string",
              "maxLength": 300
            }
          },
          {
            "name": "trim",
            "in": "query",
            "required": false,
            "description": "Accepted for compatibility and ignored.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "Page cursor (the `cursor` from a previous response).",
            "schema": {
              "type": "string",
              "maxLength": 8
            }
          },
          {
            "name": "hydrate",
            "in": "query",
            "required": false,
            "description": "SignalShelf extension: how many top results to hydrate through the matching public guest op (default 3, max 8, 0 = search-engine fields only).",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "maximum": 8
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/tiktok/shop/product/reviews": {
      "get": {
        "operationId": "tiktokShopProductReviews",
        "summary": "Reviews of a TikTok Shop product",
        "tags": [
          "TikTok"
        ],
        "description": "Partial: product rating breakdown plus the first page of public reviews from the product page. Reviewer names are masked by TikTok; reviewer IDs/avatars are not returned. page>1 is not available to guests.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "Product URL (shop.tiktok.com//pdp//).",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://shop.tiktok.com/us/pdp/sony-ps5-dualsense-wireless-controller-galactic-purple/1732127171990360790"
          },
          {
            "name": "product_id",
            "in": "query",
            "required": false,
            "description": "Numeric product ID.",
            "schema": {
              "type": "string",
              "pattern": "^\\d{1,30}$",
              "maxLength": 30
            }
          },
          {
            "name": "region",
            "in": "query",
            "required": false,
            "description": "ISO-3166 alpha-2 country. Where it matters the guest session exits from this country.",
            "schema": {
              "type": "string",
              "maxLength": 2
            },
            "example": "US"
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "description": "page",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/tiktok/shop/products": {
      "get": {
        "operationId": "tiktokShopProducts",
        "summary": "Products of a public TikTok Shop store",
        "tags": [
          "TikTok"
        ],
        "description": "Partial: first page (20) of a public store page on shop.tiktok.com; returns has_more but further pages need a signed shop API.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Store URL, e.g. https://shop.tiktok.com/us/store// (www.tiktok.com/shop/store/... also accepted).",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://shop.tiktok.com/us/store/newegg-inc/7495122322888035030"
          },
          {
            "name": "sort_by",
            "in": "query",
            "required": false,
            "description": "Not supported.",
            "schema": {
              "type": "string",
              "maxLength": 256
            }
          },
          {
            "name": "region",
            "in": "query",
            "required": false,
            "description": "ISO-3166 alpha-2 country. Where it matters the guest session exits from this country.",
            "schema": {
              "type": "string",
              "maxLength": 2
            },
            "example": "US"
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "Pagination cursor from the previous response.",
            "schema": {
              "type": "string",
              "maxLength": 4096
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/tiktok/song": {
      "get": {
        "operationId": "tiktokSong",
        "summary": "TikTok sound details",
        "tags": [
          "TikTok"
        ],
        "description": "Partial: public sound embed page (artist, cover, video count) plus title/duration from a video that uses the sound. Play URL is not returned.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "clipId",
            "in": "query",
            "required": true,
            "description": "Numeric sound (music) ID or a /music/ URL.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "7702504816472640270"
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/tiktok/song/videos": {
      "get": {
        "operationId": "tiktokSongVideos",
        "summary": "Videos using a TikTok sound",
        "tags": [
          "TikTok"
        ],
        "description": "Partial: the public sound embed video list (one page, no pagination).\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "clipId",
            "in": "query",
            "required": true,
            "description": "Numeric sound (music) ID or a /music/ URL.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "7702504816472640270"
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "Pagination cursor from the previous response.",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "maximum": 1000000000000000
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/tiktok/user/followers": {
      "get": {
        "operationId": "tiktokUserFollowers",
        "summary": "Public follower list of a TikTok profile",
        "tags": [
          "TikTok"
        ],
        "description": "Follower list as shown to logged-out web visitors (TikTok may truncate). Paginate with min_time from the previous response.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": false,
            "description": "Public TikTok handle without @ (an @handle or profile URL is also accepted).",
            "schema": {
              "type": "string",
              "maxLength": 120
            },
            "example": "nasa"
          },
          {
            "name": "user_id",
            "in": "query",
            "required": false,
            "description": "Ignored; handle required in guest mode.",
            "schema": {
              "type": "string",
              "maxLength": 256
            }
          },
          {
            "name": "trim",
            "in": "query",
            "required": false,
            "description": "Accepted for compatibility; responses are always normalized.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "min_time",
            "in": "query",
            "required": false,
            "description": "Cursor (unix seconds) from the previous page.",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "maximum": 1000000000000
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/tiktok/user/following": {
      "get": {
        "operationId": "tiktokUserFollowing",
        "summary": "Accounts a TikTok profile follows",
        "tags": [
          "TikTok"
        ],
        "description": "Following list as shown to logged-out web visitors. Paginate with min_time.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "Public TikTok handle without @ (an @handle or profile URL is also accepted).",
            "schema": {
              "type": "string",
              "maxLength": 120
            },
            "example": "nasa"
          },
          {
            "name": "trim",
            "in": "query",
            "required": false,
            "description": "Accepted for compatibility; responses are always normalized.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "min_time",
            "in": "query",
            "required": false,
            "description": "Cursor (unix seconds) from the previous page.",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "maximum": 1000000000000
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/tiktok/user/live": {
      "get": {
        "operationId": "tiktokUserLive",
        "summary": "Is a TikTok user live",
        "tags": [
          "TikTok"
        ],
        "description": "Live status and room summary for a handle from TikTok's public live-room lookup.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "Public TikTok handle without @ (an @handle or profile URL is also accepted).",
            "schema": {
              "type": "string",
              "maxLength": 120
            },
            "example": "nasa"
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v2/tiktok/video": {
      "get": {
        "operationId": "tiktokVideo",
        "summary": "Public TikTok video details",
        "tags": [
          "TikTok"
        ],
        "description": "Reads the logged-out video page. Includes TikTok caption/subtitle track URLs (WebVTT) when TikTok exposes them. get_transcript=true also downloads the first caption track.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Public TikTok video URL (https://www.tiktok.com/@user/video/) or a bare numeric video ID.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://www.tiktok.com/@nasa/video/7702504724049743117"
          },
          {
            "name": "region",
            "in": "query",
            "required": false,
            "description": "ISO-3166 alpha-2 country. Where it matters the guest session exits from this country.",
            "schema": {
              "type": "string",
              "maxLength": 2
            },
            "example": "US"
          },
          {
            "name": "get_transcript",
            "in": "query",
            "required": false,
            "description": "Also fetch and parse TikTok's own caption track.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "trim",
            "in": "query",
            "required": false,
            "description": "Accepted for compatibility; responses are always normalized.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "download_media",
            "in": "query",
            "required": false,
            "description": "Not supported (media is never downloaded).",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "cache_max_age",
            "in": "query",
            "required": false,
            "description": "Ignored.",
            "schema": {
              "type": "string",
              "maxLength": 256
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/tiktok/video/comment/replies": {
      "get": {
        "operationId": "tiktokVideoCommentReplies",
        "summary": "Replies to a TikTok comment",
        "tags": [
          "TikTok"
        ],
        "description": "Public replies to one comment. Paginate with cursor.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "comment_id",
            "in": "query",
            "required": true,
            "description": "Numeric comment ID (cid).",
            "schema": {
              "type": "string",
              "pattern": "^\\d{1,30}$",
              "maxLength": 30
            },
            "example": "7702691630143521567"
          },
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Public TikTok video URL (https://www.tiktok.com/@user/video/) or a bare numeric video ID.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://www.tiktok.com/@nasa/video/7702504724049743117"
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "Pagination cursor from the previous response.",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "maximum": 1000000000000000
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/tiktok/video/comments": {
      "get": {
        "operationId": "tiktokVideoComments",
        "summary": "Public comments on a TikTok video",
        "tags": [
          "TikTok"
        ],
        "description": "Top-level public comments via the web comment list, called from inside a tiktok.com page. Paginate with cursor.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Public TikTok video URL (https://www.tiktok.com/@user/video/) or a bare numeric video ID.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://www.tiktok.com/@nasa/video/7702504724049743117"
          },
          {
            "name": "trim",
            "in": "query",
            "required": false,
            "description": "Accepted for compatibility; responses are always normalized.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "Pagination cursor from the previous response.",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "maximum": 1000000000000000
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/tiktok/video/transcript": {
      "get": {
        "operationId": "tiktokVideoTranscript",
        "summary": "TikTok video transcript",
        "tags": [
          "TikTok"
        ],
        "description": "Returns the video's own WebVTT caption track published by TikTok (transcript_source \"auto\"/\"creator\"). When TikTok exposes no captions, runs speech-to-text on the public play URL audio (transcript_source \"ai\"); transcript is null only when ASR is not configured or the video has no audio.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Public TikTok video URL (https://www.tiktok.com/@user/video/) or a bare numeric video ID.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://www.tiktok.com/@nasa/video/7702504724049743117"
          },
          {
            "name": "language",
            "in": "query",
            "required": false,
            "description": "Preferred caption language (ISO 639-1, e.g. en); also the ASR language hint.",
            "schema": {
              "type": "string",
              "maxLength": 8
            },
            "example": "en"
          },
          {
            "name": "allow_long_transcription",
            "in": "query",
            "required": false,
            "description": "Speech-to-text fallback: transcribe up to 10 min instead of the first 2 min.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "use_ai_as_fallback",
            "in": "query",
            "required": false,
            "description": "Accepted for compatibility; the speech-to-text fallback runs automatically when TikTok has no captions.",
            "schema": {
              "type": "string",
              "maxLength": 256
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/tiktok/videos/popular": {
      "get": {
        "operationId": "tiktokVideosPopular",
        "summary": "Popular TikTok videos",
        "tags": [
          "TikTok"
        ],
        "description": "TikTok's public Explore feed (up to 30 popular videos per call, per category) instead of the login-only Creative Center list. Each page is a fresh Explore batch (no stable ranking or total); orderBy sorts within the batch. Served from an EU exit (the feed is empty on US datacenter exits).\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "period",
            "in": "query",
            "required": false,
            "description": "Accepted for compatibility (the Explore feed has no time window).",
            "schema": {
              "type": "string",
              "enum": [
                "7",
                "30"
              ],
              "maxLength": 256
            }
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "description": "Page number; every page is a new Explore batch.",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100
            }
          },
          {
            "name": "orderBy",
            "in": "query",
            "required": false,
            "description": "Sort the batch: like, hot (plays), comment, repost (shares).",
            "schema": {
              "type": "string",
              "enum": [
                "like",
                "hot",
                "comment",
                "repost"
              ],
              "maxLength": 256
            }
          },
          {
            "name": "countryCode",
            "in": "query",
            "required": false,
            "description": "Accepted for compatibility; the feed follows the EU exit region.",
            "schema": {
              "type": "string",
              "maxLength": 2
            },
            "example": "US"
          },
          {
            "name": "category",
            "in": "query",
            "required": false,
            "description": "Explore category: all, singing-dancing, comedy, sports, anime-comics, relationship, shows, lipsync, daily-life, beauty-care, games, society, outfit, cars, food, animals, family, drama, fitness-health, education, technology (default all), or a numeric categoryType.",
            "schema": {
              "type": "string",
              "maxLength": 20
            },
            "example": "all"
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/tripadvisor/reviews": {
      "get": {
        "operationId": "tripadvisorReviews",
        "summary": "Tripadvisor rating, ranking and latest review snippets",
        "tags": [
          "Tripadvisor"
        ],
        "description": "Name, bubble rating, review count, popularity ranking and the latest ≤5 review snippets (id, url, truncated text) for a hotel/restaurant/attraction, from Tripadvisor's public embed widgets. Tripadvisor pages themselves are DataDome-challenged for guests; full review text needs the Tripadvisor Content API (keyed).\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "Tripadvisor listing URL (…-g-d-…). Provide this or location_id.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://www.tripadvisor.com/Hotel_Review-g60763-d93437-Reviews-Hotel_Edison_Times_Square-New_York_City_New_York.html"
          },
          {
            "name": "location_id",
            "in": "query",
            "required": false,
            "description": "Tripadvisor location id (the d in listing URLs).",
            "schema": {
              "type": "string",
              "pattern": "^\\d{3,12}$"
            },
            "example": "93437"
          },
          {
            "name": "lang",
            "in": "query",
            "required": false,
            "description": "Widget language (default en_US).",
            "schema": {
              "type": "string",
              "pattern": "^[a-z]{2}_[A-Z]{2}$"
            },
            "example": "en_US"
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/trustpilot/business": {
      "get": {
        "operationId": "trustpilotBusiness",
        "summary": "Trustpilot business profile (TrustScore, star histogram)",
        "tags": [
          "Trustpilot"
        ],
        "description": "TrustScore, stars, review count and star histogram for a company on Trustpilot, read from Trustpilot's public TrustBox widget data (widget.trustpilot.com) after resolving the domain through the public review-collector embed page. Works for any business.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": false,
            "description": "Company domain or Trustpilot URL (e.g. www.amazon.com or https://www.trustpilot.com/review/www.amazon.com). Provide this or business_unit_id.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "www.jalbum.net"
          },
          {
            "name": "business_unit_id",
            "in": "query",
            "required": false,
            "description": "Trustpilot business unit id (24 hex chars). Skips the domain lookup.",
            "schema": {
              "type": "string",
              "pattern": "^[0-9a-f]{24}$"
            },
            "example": "46d2e4e1000064000500a0c9"
          },
          {
            "name": "locale",
            "in": "query",
            "required": false,
            "description": "Widget locale (default en-US).",
            "schema": {
              "type": "string",
              "pattern": "^[a-z]{2}-[A-Z]{2}$"
            },
            "example": "en-US"
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/trustpilot/reviews": {
      "get": {
        "operationId": "trustpilotReviews",
        "summary": "Trustpilot reviews (latest, via review widgets)",
        "tags": [
          "Trustpilot"
        ],
        "description": "Up to 100 latest reviews (rating, title, text, date, verification, company reply, reviewer display name) from Trustpilot's public review-widget data. Only businesses whose Trustpilot plan includes review TrustBoxes publish this; others return 503 SOURCE_ACCESS_RESTRICTED (no charge). No deeper pagination; slice with stars/languages.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": false,
            "description": "Company domain or Trustpilot URL (e.g. www.amazon.com or https://www.trustpilot.com/review/www.amazon.com). Provide this or business_unit_id.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "www.jalbum.net"
          },
          {
            "name": "business_unit_id",
            "in": "query",
            "required": false,
            "description": "Trustpilot business unit id (24 hex chars). Skips the domain lookup.",
            "schema": {
              "type": "string",
              "pattern": "^[0-9a-f]{24}$"
            },
            "example": "46d2e4e1000064000500a0c9"
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "Reviews to return (default 20, max 100).",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100
            },
            "example": 20
          },
          {
            "name": "stars",
            "in": "query",
            "required": false,
            "description": "Star filter, comma list (default 1,2,3,4,5).",
            "schema": {
              "type": "string",
              "pattern": "^[1-5](,[1-5]){0,4}$"
            },
            "example": "1,2"
          },
          {
            "name": "languages",
            "in": "query",
            "required": false,
            "description": "\"all\" (default) or comma list of ISO 639-1 codes.",
            "schema": {
              "type": "string",
              "maxLength": 64
            },
            "example": "en"
          },
          {
            "name": "locale",
            "in": "query",
            "required": false,
            "description": "Widget locale (default en-US).",
            "schema": {
              "type": "string",
              "pattern": "^[a-z]{2}-[A-Z]{2}$"
            },
            "example": "en-US"
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/truthsocial/post": {
      "get": {
        "operationId": "truthsocialPost",
        "summary": "Read one public Truth Social post",
        "tags": [
          "Truth Social"
        ],
        "description": "Mastodon statuses/{id} through a proxied guest browser.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Post URL, e.g. https://truthsocial.com/@user/posts/, or the numeric id.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            }
          },
          {
            "name": "download_media",
            "in": "query",
            "required": false,
            "description": "Accepted for compatibility; media URLs are always returned, files are never downloaded.",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/truthsocial/profile": {
      "get": {
        "operationId": "truthsocialProfile",
        "summary": "Read a public Truth Social profile",
        "tags": [
          "Truth Social"
        ],
        "description": "Mastodon accounts/lookup through a proxied guest browser (Cloudflare).\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "Truth Social username without @.",
            "schema": {
              "type": "string",
              "maxLength": 64
            },
            "example": "realDonaldTrump"
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/truthsocial/user/posts": {
      "get": {
        "operationId": "truthsocialUserPosts",
        "summary": "List public Truth Social posts",
        "tags": [
          "Truth Social"
        ],
        "description": "Mastodon accounts/{id}/statuses (replies excluded) through a proxied guest browser. Paginate with next_max_id.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": false,
            "description": "Username without @ (or give user_id).",
            "schema": {
              "type": "string",
              "maxLength": 64
            },
            "example": "realDonaldTrump"
          },
          {
            "name": "user_id",
            "in": "query",
            "required": false,
            "description": "Numeric account id.",
            "schema": {
              "type": "string",
              "pattern": "^[0-9]+$",
              "maxLength": 32
            }
          },
          {
            "name": "trim",
            "in": "query",
            "required": false,
            "description": "Return a slimmer object (drops raw media variants and nested author details).",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "next_max_id",
            "in": "query",
            "required": false,
            "description": "Cursor: return posts older than this id.",
            "schema": {
              "type": "string",
              "pattern": "^[0-9]+$",
              "maxLength": 32
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/twitch/clip/transcript": {
      "get": {
        "operationId": "twitchClipTranscript",
        "summary": "Transcript of a public Twitch clip (ASR)",
        "tags": [
          "Twitch"
        ],
        "description": "Runs speech-to-text on the public media audio (audio-only download, whisper). Resolves the clip MP4 through Twitch's public web GraphQL (logged-out playback token, lowest quality).\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Public Twitch clip URL (twitch.tv//clip/ or clips.twitch.tv/).",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://www.twitch.tv/shroud/clip/SlickCoweringRhinocerosShazBotstix-Bx9N2eANyf6VZWyP"
          },
          {
            "name": "allow_long_transcription",
            "in": "query",
            "required": false,
            "description": "Transcribe up to 10 min (ASR_MAX_SECONDS) instead of the first 2 min (ASR_SHORT_SECONDS). Long transcription may cost extra credits.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "use_ai_as_fallback",
            "in": "query",
            "required": false,
            "description": "Accepted for compatibility; ignored. These sources publish no captions, so the transcript is always speech-to-text (transcript_source \"ai\").",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "language",
            "in": "query",
            "required": false,
            "description": "Spoken language hint (ISO-639-1, e.g. \"en\"); default auto-detect.",
            "schema": {
              "type": "string",
              "maxLength": 8
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/twitter/community": {
      "get": {
        "operationId": "twitterCommunity",
        "summary": "Read a public X community",
        "tags": [
          "X (Twitter)"
        ],
        "description": "Logged-out CommunityQuery GraphQL: name, description, member count, rules, creator.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Community URL (x.com/i/communities/) or numeric id.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://x.com/i/communities/1493446837214187523"
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/twitter/community/tweets": {
      "get": {
        "operationId": "twitterCommunityTweets",
        "summary": "Top posts of a public X community",
        "tags": [
          "X (Twitter)"
        ],
        "description": "The public x.com/i/communities/ page as served to logged-out visitors (server-rendered): the community's top ~20 posts ranked by likes. One page, no cursor.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Community URL (x.com/i/communities/) or numeric id.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://x.com/i/communities/1493446837214187523"
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/twitter/profile": {
      "get": {
        "operationId": "twitterProfile",
        "summary": "Read a public X/Twitter profile",
        "tags": [
          "X (Twitter)"
        ],
        "description": "Logged-out X web GraphQL (UserByScreenName) with a guest token.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "X handle without @ (URL accepted).",
            "schema": {
              "type": "string",
              "maxLength": 64
            },
            "example": "NASA"
          },
          {
            "name": "cache_max_age",
            "in": "query",
            "required": false,
            "description": "Accepted for reference-API compatibility; guest reads are always live.",
            "schema": {
              "type": "string",
              "enum": [
                "1d",
                "3d",
                "7d",
                "14d",
                "30d"
              ],
              "maxLength": 2048
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/twitter/search/posts": {
      "get": {
        "operationId": "twitterSearchPosts",
        "summary": "X/Twitter post search (search-engine derived)",
        "tags": [
          "X (Twitter)"
        ],
        "description": "Built from public search-engine results (DuckDuckGo / Startpage / Brave / Bing, whichever serves a guest) for a site:-restricted query (site:x.com  status URLs). Each result is hydrated through the public twitter/tweet lookup. Coverage = what engines indexed, not X's live search.\n\nCost: 2 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "Search query.",
            "schema": {
              "type": "string",
              "maxLength": 300
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "Page cursor (the `cursor` from a previous response).",
            "schema": {
              "type": "string",
              "maxLength": 8
            }
          },
          {
            "name": "hydrate",
            "in": "query",
            "required": false,
            "description": "SignalShelf extension: how many top results to hydrate through the matching public guest op (default 8, max 15, 0 = search-engine fields only).",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "maximum": 15
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/twitter/tweet": {
      "get": {
        "operationId": "twitterTweet",
        "summary": "Read one public tweet",
        "tags": [
          "X (Twitter)"
        ],
        "description": "Logged-out TweetResultByRestId; falls back to the public syndication tweet-result endpoint.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Tweet URL (x.com or twitter.com) or numeric tweet id.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://x.com/jack/status/20"
          },
          {
            "name": "trim",
            "in": "query",
            "required": false,
            "description": "Return a slimmer object (drops raw media variants and nested author details).",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "cache_max_age",
            "in": "query",
            "required": false,
            "description": "Accepted for reference-API compatibility; guest reads are always live.",
            "schema": {
              "type": "string",
              "enum": [
                "1d",
                "3d",
                "7d",
                "14d",
                "30d"
              ],
              "maxLength": 2048
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/twitter/tweet/transcript": {
      "get": {
        "operationId": "twitterTweetTranscript",
        "summary": "Transcript of a tweet video",
        "tags": [
          "X (Twitter)"
        ],
        "description": "Reads the WebVTT captions X publishes on the tweet video HLS stream (transcript_source \"creator\"/\"auto\"). Without captions, runs speech-to-text on the lowest-bitrate MP4 variant (transcript_source \"ai\").\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Tweet URL or id of a tweet with a video.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            },
            "example": "https://x.com/NASA/status/2116655090543083550"
          },
          {
            "name": "allow_long_transcription",
            "in": "query",
            "required": false,
            "description": "Captions are returned whatever the length; the speech-to-text fallback transcribes up to 10 min instead of the first 2 min.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "cache_max_age",
            "in": "query",
            "required": false,
            "description": "Accepted for reference-API compatibility; guest reads are always live.",
            "schema": {
              "type": "string",
              "enum": [
                "1d",
                "3d",
                "7d",
                "14d",
                "30d"
              ],
              "maxLength": 2048
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/twitter/user-tweets": {
      "get": {
        "operationId": "twitterUserTweets",
        "summary": "List public tweets by an X/Twitter user",
        "tags": [
          "X (Twitter)"
        ],
        "description": "Logged-out UserTweets timeline. X serves guests a ranked (not strictly chronological) selection for very large accounts; pagination via cursor when X provides one.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "X handle without @.",
            "schema": {
              "type": "string",
              "maxLength": 64
            },
            "example": "NASA"
          },
          {
            "name": "trim",
            "in": "query",
            "required": false,
            "description": "Return a slimmer object (drops raw media variants and nested author details).",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "SignalShelf extension: next cursor from a previous page.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/web/search": {
      "get": {
        "operationId": "webSearch",
        "summary": "Web search (Google fallback)",
        "tags": [
          "Web"
        ],
        "description": "Organic web results from public search pages: Startpage (Google-sourced), then Brave, Bing, DuckDuckGo. `engine` names the one that answered. Same body as google/search.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "Search query.",
            "schema": {
              "type": "string",
              "maxLength": 300
            }
          },
          {
            "name": "region",
            "in": "query",
            "required": false,
            "description": "2-letter country code (best effort per engine).",
            "schema": {
              "type": "string",
              "maxLength": 2
            }
          },
          {
            "name": "date_posted",
            "in": "query",
            "required": false,
            "description": "Restrict to results from the last hour/day/week/month/year (search-engine freshness filter; last-hour is treated as last-day).",
            "schema": {
              "type": "string",
              "enum": [
                "last-hour",
                "last-day",
                "last-week",
                "last-month",
                "last-year"
              ],
              "maxLength": 512
            }
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "description": "Result page (1-based).",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 10
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/youtube/shorts/trending": {
      "get": {
        "operationId": "youtubeShortsTrending",
        "summary": "Logged-out YouTube Shorts feed",
        "tags": [
          "YouTube"
        ],
        "description": "Shorts YouTube serves a fresh logged-out visitor for a region (youtube.com/shorts feed). YouTube no longer publishes a Trending page, so this is a guest feed sample, not an official ranked chart. Titles/authors via oEmbed; no view counts.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "region",
            "in": "query",
            "required": false,
            "description": "ISO country code for the feed (default US).",
            "schema": {
              "type": "string",
              "maxLength": 2
            },
            "example": "US"
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "Number of Shorts (default 20).",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 30
            },
            "example": 20
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/bluesky/profile": {
      "get": {
        "operationId": "blueskyProfile",
        "summary": "Read a public Bluesky profile",
        "tags": [
          "Bluesky"
        ],
        "description": "Read a public Bluesky profile.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "Full public Bluesky handle or DID, without @ or a URL.",
            "schema": {
              "type": "string",
              "maxLength": 253,
              "example": "bsky.app"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/bluesky/user/posts": {
      "get": {
        "operationId": "blueskyUserPosts",
        "summary": "List public posts and reposts by an author",
        "tags": [
          "Bluesky"
        ],
        "description": "List public posts and reposts by an author.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": false,
            "description": "Full public Bluesky handle, without @ or a URL.",
            "schema": {
              "type": "string",
              "maxLength": 253,
              "example": "bsky.app"
            }
          },
          {
            "name": "user_id",
            "in": "query",
            "required": false,
            "description": "Bluesky DID (e.g. did:plc:…). Uses the public AppView feed endpoint.",
            "schema": {
              "type": "string",
              "maxLength": 253
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "SignalShelf extension: number of author-feed items to request. Not part of the reference API contract.",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "default": 30
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "SignalShelf extension: opaque next_cursor from the previous page. Not part of the reference API contract.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            }
          },
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "description": "SignalShelf extension: Bluesky author-feed filter. Not part of the reference API contract.",
            "schema": {
              "type": "string",
              "enum": [
                "posts_with_replies",
                "posts_no_replies",
                "posts_with_media",
                "posts_and_author_threads",
                "posts_with_video"
              ],
              "default": "posts_with_replies"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/bluesky/post": {
      "get": {
        "operationId": "blueskyPost",
        "summary": "Read one public Bluesky post",
        "tags": [
          "Bluesky"
        ],
        "description": "Read one public Bluesky post.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Canonical public Bluesky post URL, e.g. https://bsky.app/profile/name.bsky.social/post/3…",
            "schema": {
              "type": "string",
              "maxLength": 2048
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/youtube/channel": {
      "get": {
        "operationId": "youtubeChannel",
        "summary": "Read a public youtube profile",
        "tags": [
          "YouTube"
        ],
        "description": "Read a public youtube profile.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "required": false,
            "description": "Public YouTube channel ID beginning with UC; provide this or a channel handle.",
            "schema": {
              "type": "string",
              "pattern": "^UC[A-Za-z0-9_-]{22}$"
            }
          },
          {
            "name": "handle",
            "in": "query",
            "required": false,
            "description": "Public account or channel handle accepted by this operation.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "Public profile, post, or media URL accepted by this operation.",
            "schema": {
              "type": "string",
              "format": "uri"
            }
          },
          {
            "name": "cache_max_age",
            "in": "query",
            "required": false,
            "description": "Maximum age of a cached response to accept; SignalShelf retains data for no more than seven days.",
            "schema": {
              "type": "string",
              "enum": [
                "1d",
                "3d",
                "7d",
                "14d",
                "30d"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/youtube/channel-videos": {
      "get": {
        "operationId": "youtubeChannelVideos",
        "summary": "List the latest videos from a public YouTube channel",
        "tags": [
          "YouTube"
        ],
        "description": "List the latest videos from a public YouTube channel.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "required": false,
            "description": "Public YouTube channel ID beginning with UC.",
            "schema": {
              "type": "string",
              "example": "UCBJycsmduvYEL83R_U4JriQ",
              "maxLength": 24,
              "pattern": "^UC[A-Za-z0-9_-]{22}$"
            }
          },
          {
            "name": "handle",
            "in": "query",
            "required": false,
            "description": "Public channel handle, with or without @.",
            "schema": {
              "type": "string",
              "maxLength": 100,
              "pattern": "^@?[A-Za-z0-9._-]{3,100}$"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "required": false,
            "description": "Newest uploads are the only supported order.",
            "schema": {
              "type": "string",
              "enum": [
                "latest"
              ],
              "default": "latest"
            }
          },
          {
            "name": "continuationToken",
            "in": "query",
            "required": false,
            "description": "Opaque SignalShelf cursor from the previous page. Keep the same channel ID or handle and sort.",
            "schema": {
              "type": "string",
              "maxLength": 12000
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/youtube/video": {
      "get": {
        "operationId": "youtubeVideo",
        "summary": "Read publicly available YouTube video or Short details",
        "tags": [
          "YouTube"
        ],
        "description": "Read publicly available YouTube video or Short details.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Public YouTube watch, Shorts or youtu.be URL. Private, unlisted-only, age-gated and otherwise inaccessible videos are not extracted.",
            "schema": {
              "type": "string",
              "example": "https://www.youtube.com/watch?v=2reQut8WNGc",
              "maxLength": 2048
            }
          },
          {
            "name": "language",
            "in": "query",
            "required": false,
            "description": "Optional BCP-47 page language tag, for example en or hi.",
            "schema": {
              "type": "string",
              "maxLength": 35,
              "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/youtube/search": {
      "get": {
        "operationId": "youtubeSearch",
        "summary": "Search public YouTube videos and channels",
        "tags": [
          "YouTube"
        ],
        "description": "Search public YouTube videos and channels.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "Search terms.",
            "schema": {
              "type": "string",
              "example": "mkbhd",
              "maxLength": 200
            }
          },
          {
            "name": "type",
            "in": "query",
            "required": false,
            "description": "YouTube public search result category to request.",
            "schema": {
              "type": "string",
              "enum": [
                "videos",
                "shorts",
                "channels",
                "playlists"
              ]
            }
          },
          {
            "name": "uploadDate",
            "in": "query",
            "required": false,
            "description": "Restrict results to a public YouTube upload-date range.",
            "schema": {
              "type": "string",
              "enum": [
                "today",
                "this_week",
                "this_month",
                "this_year"
              ]
            }
          },
          {
            "name": "sortBy",
            "in": "query",
            "required": false,
            "description": "Order results by relevance or YouTube popularity.",
            "schema": {
              "type": "string",
              "enum": [
                "relevance",
                "popular"
              ]
            }
          },
          {
            "name": "duration",
            "in": "query",
            "required": false,
            "description": "Restrict video results by duration.",
            "schema": {
              "type": "string",
              "enum": [
                "under_3_min",
                "between_3_and_20_min",
                "over_20_min"
              ]
            }
          },
          {
            "name": "region",
            "in": "query",
            "required": false,
            "description": "Two-letter ISO 3166-1 alpha-2 country code for YouTube’s public search results, for example US or IN.",
            "schema": {
              "type": "string",
              "maxLength": 2,
              "pattern": "^[A-Za-z]{2}$"
            }
          },
          {
            "name": "continuationToken",
            "in": "query",
            "required": false,
            "description": "Opaque SignalShelf cursor from the previous response. Keep the same query and filters.",
            "schema": {
              "type": "string",
              "maxLength": 12000
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/youtube/search/hashtag": {
      "get": {
        "operationId": "youtubeSearchHashtag",
        "summary": "Search public YouTube videos for a hashtag",
        "tags": [
          "YouTube"
        ],
        "description": "Search public YouTube videos for a hashtag.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "hashtag",
            "in": "query",
            "required": true,
            "description": "Hashtag text, with or without a leading #.",
            "schema": {
              "type": "string",
              "example": "shorts",
              "maxLength": 100,
              "pattern": "^#?[A-Za-z0-9_]{1,100}$"
            }
          },
          {
            "name": "type",
            "in": "query",
            "required": false,
            "description": "Return all public hashtag results or only results identified as Shorts.",
            "schema": {
              "type": "string",
              "enum": [
                "all",
                "shorts"
              ],
              "default": "all"
            }
          },
          {
            "name": "continuationToken",
            "in": "query",
            "required": false,
            "description": "Opaque SignalShelf cursor from the previous page. Keep the same hashtag and type.",
            "schema": {
              "type": "string",
              "maxLength": 12000
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/youtube/channel/search": {
      "get": {
        "operationId": "youtubeChannelSearch",
        "summary": "Search public videos within a YouTube channel",
        "tags": [
          "YouTube"
        ],
        "description": "Search public videos within a YouTube channel.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "Public YouTube channel handle, with or without @.",
            "schema": {
              "type": "string",
              "example": "NASA",
              "maxLength": 100
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "Words to search within the channel.",
            "schema": {
              "type": "string",
              "example": "artemis",
              "maxLength": 100
            }
          },
          {
            "name": "continuationToken",
            "in": "query",
            "required": false,
            "description": "Opaque SignalShelf cursor from the previous response. Keep the same handle and query.",
            "schema": {
              "type": "string",
              "maxLength": 12000
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/youtube/channel/playlists": {
      "get": {
        "operationId": "youtubeChannelPlaylists",
        "summary": "List public playlists from a YouTube channel",
        "tags": [
          "YouTube"
        ],
        "description": "List public playlists from a YouTube channel.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "required": false,
            "description": "Public YouTube channel ID beginning with UC.",
            "schema": {
              "type": "string",
              "maxLength": 24,
              "pattern": "^UC[A-Za-z0-9_-]{22}$"
            }
          },
          {
            "name": "handle",
            "in": "query",
            "required": false,
            "description": "Public channel handle, with or without @.",
            "schema": {
              "type": "string",
              "example": "NASA",
              "maxLength": 100,
              "pattern": "^@?[A-Za-z0-9._-]{3,100}$"
            }
          },
          {
            "name": "continuationToken",
            "in": "query",
            "required": false,
            "description": "Opaque SignalShelf cursor from the previous response. Keep the same channel ID or handle.",
            "schema": {
              "type": "string",
              "maxLength": 12000
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/youtube/channel/lives": {
      "get": {
        "operationId": "youtubeChannelLives",
        "summary": "List public live streams and past broadcasts from a channel",
        "tags": [
          "YouTube"
        ],
        "description": "List public live streams and past broadcasts from a channel.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "required": false,
            "description": "Public YouTube channel ID beginning with UC.",
            "schema": {
              "type": "string",
              "maxLength": 24,
              "pattern": "^UC[A-Za-z0-9_-]{22}$"
            }
          },
          {
            "name": "handle",
            "in": "query",
            "required": false,
            "description": "Public channel handle, with or without @.",
            "schema": {
              "type": "string",
              "example": "NASA",
              "maxLength": 100,
              "pattern": "^@?[A-Za-z0-9._-]{3,100}$"
            }
          },
          {
            "name": "continuationToken",
            "in": "query",
            "required": false,
            "description": "Opaque SignalShelf cursor from the previous response. Keep the same channel identity.",
            "schema": {
              "type": "string",
              "maxLength": 12000
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/youtube/channel/shorts": {
      "get": {
        "operationId": "youtubeChannelShorts",
        "summary": "List public YouTube Shorts from a channel",
        "tags": [
          "YouTube"
        ],
        "description": "List public YouTube Shorts from a channel.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "required": false,
            "description": "Public YouTube channel ID beginning with UC.",
            "schema": {
              "type": "string",
              "maxLength": 24,
              "pattern": "^UC[A-Za-z0-9_-]{22}$"
            }
          },
          {
            "name": "handle",
            "in": "query",
            "required": false,
            "description": "Public channel handle, with or without @.",
            "schema": {
              "type": "string",
              "example": "NASA",
              "maxLength": 100,
              "pattern": "^@?[A-Za-z0-9._-]{3,100}$"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "required": false,
            "description": "Newest Shorts are the only verified ordering.",
            "schema": {
              "type": "string",
              "enum": [
                "newest"
              ],
              "default": "newest"
            }
          },
          {
            "name": "continuationToken",
            "in": "query",
            "required": false,
            "description": "Opaque SignalShelf cursor from the previous response. Keep the same channel identity.",
            "schema": {
              "type": "string",
              "maxLength": 12000
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/youtube/search/typeahead": {
      "get": {
        "operationId": "youtubeSearchTypeahead",
        "summary": "Get public YouTube search suggestions",
        "tags": [
          "YouTube"
        ],
        "description": "Get public YouTube search suggestions.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "Search text to complete.",
            "schema": {
              "type": "string",
              "example": "mkbhd",
              "maxLength": 100
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/youtube/video/comments": {
      "get": {
        "operationId": "youtubeVideoComments",
        "summary": "List public comments on a YouTube video",
        "tags": [
          "YouTube"
        ],
        "description": "List public comments on a YouTube video.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Public YouTube watch, Shorts or youtu.be URL. Private, unlisted-only, age-gated and otherwise inaccessible videos are not extracted.",
            "schema": {
              "type": "string",
              "example": "https://www.youtube.com/watch?v=2reQut8WNGc",
              "maxLength": 2048
            }
          },
          {
            "name": "order",
            "in": "query",
            "required": false,
            "description": "Sort by the source’s Top or Newest comment order.",
            "schema": {
              "type": "string",
              "enum": [
                "top",
                "newest"
              ],
              "default": "top"
            }
          },
          {
            "name": "continuationToken",
            "in": "query",
            "required": false,
            "description": "Opaque SignalShelf cursor from the previous comments page. Keep the same video and order.",
            "schema": {
              "type": "string",
              "maxLength": 12000
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/youtube/video/comment/replies": {
      "get": {
        "operationId": "youtubeVideoCommentReplies",
        "summary": "List replies to a public YouTube comment",
        "tags": [
          "YouTube"
        ],
        "description": "List replies to a public YouTube comment.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "continuationToken",
            "in": "query",
            "required": true,
            "description": "Copy the replies_cursor from a comment returned by video/comments.",
            "schema": {
              "type": "string",
              "example": "PASTE_REPLIES_CURSOR_FROM_COMMENTS_RESPONSE",
              "maxLength": 12000
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/youtube/playlist": {
      "get": {
        "operationId": "youtubePlaylist",
        "summary": "Read videos from a public YouTube playlist",
        "tags": [
          "YouTube"
        ],
        "description": "Read videos from a public YouTube playlist.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "playlist_id",
            "in": "query",
            "required": true,
            "description": "Public YouTube playlist ID.",
            "schema": {
              "type": "string",
              "example": "PLF98rxtslw6s",
              "maxLength": 120,
              "pattern": "^[A-Za-z0-9_-]{10,120}$"
            }
          },
          {
            "name": "continuationToken",
            "in": "query",
            "required": false,
            "description": "Opaque SignalShelf cursor from the previous response. Keep the same playlist_id.",
            "schema": {
              "type": "string",
              "maxLength": 12000
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/youtube/channel/community-posts": {
      "get": {
        "operationId": "youtubeChannelCommunityPosts",
        "summary": "List public YouTube community posts from a channel",
        "tags": [
          "YouTube"
        ],
        "description": "List public YouTube community posts from a channel.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "required": false,
            "description": "Public YouTube channel ID beginning with UC.",
            "schema": {
              "type": "string",
              "maxLength": 24,
              "pattern": "^UC[A-Za-z0-9_-]{22}$"
            }
          },
          {
            "name": "handle",
            "in": "query",
            "required": false,
            "description": "Public channel handle, with or without @.",
            "schema": {
              "type": "string",
              "example": "NASA",
              "maxLength": 100,
              "pattern": "^@?[A-Za-z0-9._-]{3,100}$"
            }
          },
          {
            "name": "continuationToken",
            "in": "query",
            "required": false,
            "description": "Opaque SignalShelf cursor from the previous page. Keep the same channel identity.",
            "schema": {
              "type": "string",
              "maxLength": 12000
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/youtube/community-post": {
      "get": {
        "operationId": "youtubeCommunityPost",
        "summary": "Read a public YouTube community post",
        "tags": [
          "YouTube"
        ],
        "description": "Read a public YouTube community post.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Canonical public YouTube community post URL.",
            "schema": {
              "type": "string",
              "example": "https://www.youtube.com/post/Ugkx8d2zGpXJ02eZbjGjdzQPCXSn3qBu9PJt",
              "maxLength": 2048
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/youtube/video/sponsors": {
      "get": {
        "operationId": "youtubeVideoSponsors",
        "summary": "Infer possible sponsors from public YouTube video evidence",
        "tags": [
          "YouTube"
        ],
        "description": "Infer possible sponsors from public YouTube video evidence.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Public YouTube watch, Shorts or youtu.be URL. Private, unlisted-only, age-gated and otherwise inaccessible videos are not extracted.",
            "schema": {
              "type": "string",
              "example": "https://www.youtube.com/watch?v=2reQut8WNGc",
              "maxLength": 2048
            }
          },
          {
            "name": "language",
            "in": "query",
            "required": false,
            "description": "Optional two-letter YouTube page language hint.",
            "schema": {
              "type": "string",
              "maxLength": 2,
              "pattern": "^[A-Za-z]{2}$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/twitch/profile": {
      "get": {
        "operationId": "twitchProfile",
        "summary": "Read a public twitch profile",
        "tags": [
          "Twitch"
        ],
        "description": "Read a public twitch profile.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "Public account or channel handle accepted by this operation.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "cache_max_age",
            "in": "query",
            "required": false,
            "description": "Maximum age of a cached response to accept; SignalShelf retains data for no more than seven days.",
            "schema": {
              "type": "string",
              "enum": [
                "1d",
                "3d",
                "7d",
                "14d",
                "30d"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/twitch/user/schedule": {
      "get": {
        "operationId": "twitchUserSchedule",
        "summary": "Read a public Twitch channel schedule",
        "tags": [
          "Twitch"
        ],
        "description": "Read a public Twitch channel schedule.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "handle",
            "in": "query",
            "required": true,
            "description": "Public Twitch channel login, without @ or a URL.",
            "schema": {
              "type": "string",
              "maxLength": 25,
              "pattern": "^[A-Za-z0-9_]{1,25}$",
              "example": "shroud"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/apple-music/artist": {
      "get": {
        "operationId": "appleMusicArtist",
        "summary": "Read a public Apple Music artist and related catalog items",
        "tags": [
          "Apple Music"
        ],
        "description": "Read a public Apple Music artist and related catalog items.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": false,
            "description": "Numeric Apple Music catalog identifier.",
            "schema": {
              "type": "string",
              "maxLength": 24,
              "pattern": "^\\d{1,24}$"
            }
          },
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "Apple Music artist, album, or song URL on music.apple.com.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            }
          },
          {
            "name": "storefront",
            "in": "query",
            "required": false,
            "description": "Two-letter storefront country code. A country in the supplied URL takes precedence.",
            "schema": {
              "type": "string",
              "maxLength": 2,
              "pattern": "^[A-Za-z]{2}$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/apple-music/album": {
      "get": {
        "operationId": "appleMusicAlbum",
        "summary": "Read a public Apple Music album and its tracks",
        "tags": [
          "Apple Music"
        ],
        "description": "Read a public Apple Music album and its tracks.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": false,
            "description": "Numeric Apple Music catalog identifier.",
            "schema": {
              "type": "string",
              "maxLength": 24,
              "pattern": "^\\d{1,24}$"
            }
          },
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "Apple Music artist, album, or song URL on music.apple.com.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            }
          },
          {
            "name": "storefront",
            "in": "query",
            "required": false,
            "description": "Two-letter storefront country code. A country in the supplied URL takes precedence.",
            "schema": {
              "type": "string",
              "maxLength": 2,
              "pattern": "^[A-Za-z]{2}$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/apple-music/track": {
      "get": {
        "operationId": "appleMusicTrack",
        "summary": "Read a public Apple Music song",
        "tags": [
          "Apple Music"
        ],
        "description": "Read a public Apple Music song.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": false,
            "description": "Numeric Apple Music catalog identifier.",
            "schema": {
              "type": "string",
              "maxLength": 24,
              "pattern": "^\\d{1,24}$"
            }
          },
          {
            "name": "url",
            "in": "query",
            "required": false,
            "description": "Apple Music artist, album, or song URL on music.apple.com.",
            "schema": {
              "type": "string",
              "maxLength": 2048
            }
          },
          {
            "name": "storefront",
            "in": "query",
            "required": false,
            "description": "Two-letter storefront country code. A country in the supplied URL takes precedence.",
            "schema": {
              "type": "string",
              "maxLength": 2,
              "pattern": "^[A-Za-z]{2}$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    },
    "/v1/apple-music/search": {
      "get": {
        "operationId": "appleMusicSearch",
        "summary": "Search the public Apple music catalog",
        "tags": [
          "Apple Music"
        ],
        "description": "Search the public Apple music catalog.\n\nCost: 1 credit(s) per successful call. Failed calls are free.",
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "Catalog search query.",
            "schema": {
              "type": "string",
              "maxLength": 200,
              "example": "Taylor Swift"
            }
          },
          {
            "name": "type",
            "in": "query",
            "required": false,
            "description": "Supported public catalog result type.",
            "schema": {
              "type": "string",
              "enum": [
                "all",
                "artist",
                "album",
                "song",
                "music_video"
              ],
              "default": "all"
            }
          },
          {
            "name": "storefront",
            "in": "query",
            "required": false,
            "description": "Two-letter storefront country code; defaults to the US catalog.",
            "schema": {
              "type": "string",
              "maxLength": 2,
              "pattern": "^[A-Za-z]{2}$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success. Same JSON shape as the ScrapeCreators/Outscraper endpoint at this path.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters. No credits charged."
          },
          "404": {
            "description": "Not found or private. No credits charged."
          },
          "429": {
            "description": "Rate limited."
          },
          "502": {
            "description": "Upstream failed after retries. No credits charged."
          }
        }
      }
    }
  }
}