{ "openapi": "3.1.0", "info": { "title": "Scrape Everything API", "version": "1.0.0", "description": "Public social media data as JSON. Every endpoint is a POST with a JSON body. Pay per successful request; x-credits on each operation is its credit cost. Docs: https://scrapeeverything.com/docs", "contact": { "name": "Scrape Everything", "email": "info@scrapeeverything.com", "url": "https://scrapeeverything.com/support" }, "termsOfService": "https://scrapeeverything.com/terms" }, "servers": [ { "url": "https://api.scrapeeverything.com" } ], "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "Instagram" }, { "name": "X (Twitter)" }, { "name": "TikTok" }, { "name": "YouTube" }, { "name": "Facebook" }, { "name": "Telegram" }, { "name": "Spotify" }, { "name": "Pinterest" }, { "name": "Twitch" } ], "paths": { "/v1/instagram/profile": { "post": { "operationId": "instagram_profile", "summary": "Instagram profile", "description": "Public profile of an Instagram account: bio, avatar, verification/business flags, follower/following/post counts and story-highlight info.\n\n- Private and login-gated accounts return the public subset of fields; unavailable values are null.\n- Age-restricted profiles return 404 with code AGE_RESTRICTED.\n\nCost: 1 credit per successful request.", "tags": [ "Instagram" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/instagram#instagram-profile" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "username": { "type": "string", "description": "Instagram username, @handle or profile URL.", "examples": [ "instagram" ] }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [ "username" ] }, "example": { "username": "instagram" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Instagram numeric user ID as string" }, "username": { "type": "string", "description": "Instagram username" }, "full_name": { "type": "string", "description": "Display name; empty string if none" }, "biography": { "type": "string", "description": "Bio text; empty string if none" }, "external_url": { "type": [ "string", "null" ], "description": "Website link shown in bio" }, "profile_pic_url": { "type": [ "string", "null" ], "description": "Profile picture URL (standard size)" }, "profile_pic_url_hd": { "type": [ "string", "null" ], "description": "Profile picture URL (high resolution)" }, "is_private": { "type": "boolean", "description": "Account is private" }, "is_verified": { "type": "boolean", "description": "Account has verified badge" }, "is_business_account": { "type": "boolean", "description": "Account is a business account" }, "category_name": { "type": [ "string", "null" ], "description": "Business/creator category label" }, "follower_count": { "type": [ "integer", "null" ], "description": "Number of followers" }, "following_count": { "type": [ "integer", "null" ], "description": "Number of accounts followed" }, "post_count": { "type": [ "integer", "null" ], "description": "Number of posts published" }, "has_highlights": { "type": [ "boolean", "null" ], "description": "Has story highlights; null if unknown/private" }, "highlight_count": { "type": [ "integer", "null" ], "description": "Story highlight count; null if unknown/private" } }, "required": [ "id", "username", "full_name", "biography", "is_private", "is_verified", "is_business_account" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/instagram/photos": { "post": { "operationId": "instagram_photos", "summary": "Instagram posts", "description": "An Instagram profile plus its most recent posts (up to 60) with type, caption, thumbnail and engagement counts where available.\n\n- Returns every instagram.profile field plus up to 60 recent posts, newest first.\n- posts_source shows where the posts came from. Some sources do not include like and comment counts (null).\n- Private accounts return an empty posts array.\n\nCost: 2 credits per successful request.", "tags": [ "Instagram" ], "x-credits": 2, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/instagram#instagram-photos" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "username": { "type": "string", "description": "Instagram username, @handle or profile URL.", "examples": [ "nasa" ] }, "limit": { "type": "integer", "description": "Maximum number of posts to return.", "examples": [ 12 ], "default": 12, "minimum": 1, "maximum": 60 }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [ "username" ] }, "example": { "username": "nasa", "limit": 12 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Instagram numeric user ID as string" }, "username": { "type": "string", "description": "Instagram username" }, "full_name": { "type": "string", "description": "Display name; empty string if none" }, "biography": { "type": "string", "description": "Bio text; empty string if none" }, "external_url": { "type": [ "string", "null" ], "description": "Website link shown in bio" }, "profile_pic_url": { "type": [ "string", "null" ], "description": "Profile picture URL (standard size)" }, "profile_pic_url_hd": { "type": [ "string", "null" ], "description": "Profile picture URL (high resolution)" }, "is_private": { "type": "boolean", "description": "Account is private" }, "is_verified": { "type": "boolean", "description": "Account has verified badge" }, "is_business_account": { "type": "boolean", "description": "Account is a business account" }, "category_name": { "type": [ "string", "null" ], "description": "Business/creator category label" }, "follower_count": { "type": [ "integer", "null" ], "description": "Number of followers" }, "following_count": { "type": [ "integer", "null" ], "description": "Number of accounts followed" }, "post_count": { "type": [ "integer", "null" ], "description": "Number of posts published" }, "has_highlights": { "type": [ "boolean", "null" ], "description": "Has story highlights; null if unknown/private" }, "highlight_count": { "type": [ "integer", "null" ], "description": "Story highlight count; null if unknown/private" }, "posts": { "type": "array", "items": { "type": "object", "properties": { "shortcode": { "type": "string", "description": "Post shortcode (URL code)" }, "link": { "type": "string", "description": "Post URL (https://www.instagram.com/p//)" }, "type": { "type": "string", "description": "'photo', 'video' or 'album'" }, "is_video": { "type": "boolean", "description": "Post is a video/reel" }, "like_count": { "type": [ "integer", "null" ], "description": "Likes; null when source lacks counts" }, "like_and_view_counts_disabled": { "type": [ "boolean", "null" ], "description": "Owner hid counts; like_count unreliable" }, "comment_count": { "type": [ "integer", "null" ], "description": "Comments; null when source lacks counts" }, "caption": { "type": "string", "description": "Caption, whitespace-collapsed, max 300 chars" }, "thumbnail_url": { "type": [ "string", "null" ], "description": "Image/cover URL (first item for albums)" }, "taken_at": { "type": [ "integer", "null" ], "description": "Publish time, Unix seconds" }, "taken_at_text": { "type": [ "string", "null" ], "description": "Day-precision date text, e.g. 'December 05, 2025'" } }, "required": [ "shortcode", "link", "type", "is_video", "caption" ] }, "description": "Most recent posts, newest first, max limit" }, "posts_fetched": { "type": "integer", "description": "Number of posts returned" }, "posts_source": { "type": "string", "description": "'feed', 'profile_html', 'profile_fallback' or 'none'" }, "has_more": { "type": "boolean", "description": "More posts exist beyond those returned" } }, "required": [ "id", "username", "full_name", "biography", "is_private", "is_verified", "is_business_account", "posts", "posts_fetched", "posts_source", "has_more" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/instagram/post": { "post": { "operationId": "instagram_post", "summary": "Instagram post", "description": "A single Instagram post/reel by URL or shortcode: owner, type, likes, comments, views, caption, timestamp, thumbnail and video URL, plus every photo and video of an album.\n\n- Works with post, reel and IGTV links or a bare shortcode.\n- Returns 404 with PRIVATE_ACCOUNT or AGE_RESTRICTED when the post exists but is not publicly viewable.\n\nCost: 1 credit per successful request.", "tags": [ "Instagram" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/instagram#instagram-post" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string", "description": "Post, reel or IGTV URL (a bare shortcode also works).", "examples": [ "https://www.instagram.com/p/DYxz0A8Kinw/" ] }, "shortcode": { "type": "string", "description": "Post shortcode; alias used only when url is empty.", "examples": [ "DYxz0A8Kinw" ] }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [], "anyOf": [ { "required": [ "url" ] }, { "required": [ "shortcode" ] } ] }, "example": { "url": "https://www.instagram.com/p/DYxz0A8Kinw/" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "shortcode": { "type": "string", "description": "Canonical 11-char shortcode (from og:url)" }, "media_id": { "type": [ "string", "null" ], "description": "'_'; null if owner id missing" }, "link": { "type": "string", "description": "Canonical post URL" }, "owner_username": { "type": [ "string", "null" ], "description": "Username of the post owner" }, "owner_full_name": { "type": [ "string", "null" ], "description": "Author display name" }, "owner_profile_pic_url": { "type": [ "string", "null" ], "description": "Author profile picture URL" }, "owner_is_verified": { "type": [ "boolean", "null" ], "description": "Author has a verified badge" }, "type": { "type": "string", "description": "'photo', 'video' or 'album'" }, "is_video": { "type": "boolean", "description": "True only if a video URL was found" }, "product_type": { "type": [ "string", "null" ], "description": "Instagram product type, e.g. 'feed', 'clips'" }, "like_count": { "type": [ "integer", "null" ], "description": "Number of likes" }, "like_and_view_counts_disabled": { "type": [ "boolean", "null" ], "description": "Owner hid counts; like/view counts unreliable" }, "comment_count": { "type": [ "integer", "null" ], "description": "Number of comments" }, "view_count": { "type": [ "integer", "null" ], "description": "Video plays/views (videos/reels)" }, "taken_at": { "type": [ "integer", "null" ], "description": "Publish time, Unix seconds" }, "taken_at_text": { "type": [ "string", "null" ], "description": "Date text from og:description, e.g. 'May 25, 2026'" }, "caption": { "type": "string", "description": "Caption, whitespace-collapsed (not truncated)" }, "thumbnail_url": { "type": [ "string", "null" ], "description": "Cover image URL" }, "video_url": { "type": [ "string", "null" ], "description": "Playable video URL (videos/reels)" }, "media": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "'photo' or 'video'" }, "image_url": { "type": [ "string", "null" ], "description": "Largest image (for videos: the cover frame)" }, "video_url": { "type": [ "string", "null" ], "description": "MP4 file for video items" }, "width": { "type": [ "integer", "null" ], "description": "Width in pixels" }, "height": { "type": [ "integer", "null" ], "description": "Height in pixels" } }, "required": [ "type" ] }, "description": "Every image/video of the post: one item for a photo or video, each slide for an album (carousel)" } }, "required": [ "shortcode", "link", "type", "is_video", "caption", "media" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/instagram/reel": { "post": { "operationId": "instagram_reel", "summary": "Instagram reel", "description": "A single Instagram reel by URL or shortcode: owner, caption, likes, comments, duration, resolution, audio, cover image and a downloadable MP4 link.\n\n- Accepts reel, post and IGTV links or a bare shortcode. Photo and album posts return 404 with code NOT_A_REEL.\n- video_url is a signed CDN link that stops working at video_url_expires_at, usually within a few days. Download it before then, for example: curl -L -o reel.mp4 \"\"\n- Returns 404 with PRIVATE_ACCOUNT or AGE_RESTRICTED when the reel exists but is not publicly viewable.\n\nCost: 1 credit per successful request.", "tags": [ "Instagram" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/instagram#instagram-reel" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string", "description": "Reel URL (/reel/, /reels/ and /p/ links work; a bare shortcode also works).", "examples": [ "https://www.instagram.com/reel/DYxz0A8Kinw/" ] }, "shortcode": { "type": "string", "description": "Reel shortcode; alias used only when url is empty.", "examples": [ "DYxz0A8Kinw" ] }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [], "anyOf": [ { "required": [ "url" ] }, { "required": [ "shortcode" ] } ] }, "example": { "url": "https://www.instagram.com/reel/DYxz0A8Kinw/" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "shortcode": { "type": "string", "description": "Canonical 11-char shortcode (from og:url)" }, "link": { "type": "string", "description": "Reel URL (https://www.instagram.com/reel//)" }, "media_id": { "type": [ "string", "null" ], "description": "'_'; null if owner id missing" }, "owner_username": { "type": [ "string", "null" ], "description": "Username of the reel owner" }, "owner_full_name": { "type": [ "string", "null" ], "description": "Author display name" }, "owner_profile_pic_url": { "type": [ "string", "null" ], "description": "Author profile picture URL" }, "owner_is_verified": { "type": [ "boolean", "null" ], "description": "Author has a verified badge" }, "caption": { "type": "string", "description": "Caption, whitespace-collapsed (not truncated)" }, "like_count": { "type": [ "integer", "null" ], "description": "Number of likes" }, "comment_count": { "type": [ "integer", "null" ], "description": "Number of comments" }, "like_and_view_counts_disabled": { "type": [ "boolean", "null" ], "description": "Owner hid counts; like/view counts unreliable" }, "view_count": { "type": [ "integer", "null" ], "description": "Plays; null when Instagram does not expose them to logged-out visitors" }, "taken_at": { "type": [ "integer", "null" ], "description": "Publish time, Unix seconds" }, "taken_at_text": { "type": [ "string", "null" ], "description": "Date text from og:description, e.g. 'May 25, 2026'" }, "duration_seconds": { "type": [ "number", "null" ], "description": "Video length in seconds, 2 decimals" }, "width": { "type": [ "integer", "null" ], "description": "Original video width in pixels" }, "height": { "type": [ "integer", "null" ], "description": "Original video height in pixels" }, "has_audio": { "type": [ "boolean", "null" ], "description": "Video has an audio track" }, "audio": { "type": [ "object", "null" ], "properties": { "title": { "type": "string", "description": "Song title, or the original audio title" }, "artist_name": { "type": [ "string", "null" ], "description": "Display artist for licensed music; null for original audio" }, "artist_username": { "type": [ "string", "null" ], "description": "Instagram username of the artist or of the original audio creator" }, "is_original": { "type": "boolean", "description": "Original audio by a creator (not licensed music)" } }, "required": [ "title", "is_original" ], "description": "Sound used in the reel; null if unknown" }, "thumbnail_url": { "type": [ "string", "null" ], "description": "Cover image URL" }, "video_url": { "type": [ "string", "null" ], "description": "MP4 file URL (signed CDN link, expires)" }, "video_url_expires_at": { "type": [ "string", "null" ], "description": "When video_url stops working, ISO 8601 (read from the signed link)" } }, "required": [ "shortcode", "link", "caption" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/instagram/comments": { "post": { "operationId": "instagram_comments", "summary": "Instagram comments", "description": "The most recent comments (up to 15) on an Instagram post or reel by URL or shortcode: text, time, likes, GIFs and author, plus the post's total comment count.\n\n- Logged-out access shows only the 15 most recent top-level comments of a post, so at most 15 comments are returned even when limit is higher. Older comments and replies are not available; has_more tells you whether more exist.\n- Comment authors' display names (full_name) are not part of logged-out data and are not returned.\n- Returns 404 with PRIVATE_ACCOUNT or AGE_RESTRICTED when the post exists but is not publicly viewable.\n\nCost: 1 credit per successful request.", "tags": [ "Instagram" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/instagram#instagram-comments" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string", "description": "Post, reel or IGTV URL (a bare shortcode also works).", "examples": [ "https://www.instagram.com/reel/DYxz0A8Kinw/" ] }, "shortcode": { "type": "string", "description": "Post shortcode; alias used only when url is empty.", "examples": [ "DYxz0A8Kinw" ] }, "limit": { "type": "integer", "description": "Maximum number of comments to return. Logged-out Instagram exposes the 15 newest top-level comments.", "examples": [ 15 ], "default": 15, "minimum": 1, "maximum": 15 }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [], "anyOf": [ { "required": [ "url" ] }, { "required": [ "shortcode" ] } ] }, "example": { "url": "https://www.instagram.com/reel/DYxz0A8Kinw/", "limit": 15 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "shortcode": { "type": "string", "description": "Canonical 11-char shortcode (from og:url)" }, "link": { "type": "string", "description": "Post URL (https://www.instagram.com/p//)" }, "comment_count": { "type": [ "integer", "null" ], "description": "Total number of comments on the post" }, "comments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Comment ID" }, "text": { "type": "string", "description": "Comment text; empty for GIF-only (see gif_url) and other media-only comments" }, "created_at": { "type": [ "integer", "null" ], "description": "Comment time, Unix seconds" }, "like_count": { "type": [ "integer", "null" ], "description": "Likes on the comment" }, "reply_count": { "type": [ "integer", "null" ], "description": "Number of replies; null when Instagram leaves it out (common in logged-out data)" }, "gif_url": { "type": [ "string", "null" ], "description": "GIF image URL for GIF comments" }, "author": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "description": "Author's numeric user ID as string" }, "username": { "type": [ "string", "null" ], "description": "Author's username" }, "profile_pic_url": { "type": [ "string", "null" ], "description": "Author's profile picture URL" }, "is_verified": { "type": "boolean", "description": "Author has verified badge" } }, "required": [ "is_verified" ], "description": "Comment author" } }, "required": [ "id", "text", "author" ] }, "description": "Most recent top-level comments, newest first, max limit (at most 15)" }, "comments_fetched": { "type": "integer", "description": "Number of comments returned" }, "has_more": { "type": "boolean", "description": "The post has more comments than were returned" } }, "required": [ "shortcode", "link", "comments", "comments_fetched", "has_more" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/instagram/reels": { "post": { "operationId": "instagram_reels", "summary": "Instagram reels", "description": "An Instagram profile's Reels tab (up to 50 reels) with views, likes, comments, cover image and approximate publish time, plus profile basics.\n\n- Reels come from the profile's public Reels tab, which also lists collab reels owned by another account (owner_id differs from id).\n- The logged-out Reels tab has no captions, exact publish times, durations or video URLs. taken_at is decoded from the media ID and is usually a few minutes earlier than the exact time; use instagram.reel with a reel's shortcode for full details.\n- Returns 404 with PRIVATE_ACCOUNT, AGE_RESTRICTED or LOGIN_REQUIRED when the account exists but its reels are not publicly viewable.\n\nCost: 2 credits per successful request.", "tags": [ "Instagram" ], "x-credits": 2, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/instagram#instagram-reels" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "username": { "type": "string", "description": "Instagram username, @handle or profile URL.", "examples": [ "nasa" ] }, "limit": { "type": "integer", "description": "Maximum number of reels to return.", "examples": [ 12 ], "default": 12, "minimum": 1, "maximum": 50 }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [ "username" ] }, "example": { "username": "nasa", "limit": 12 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Instagram numeric user ID as string" }, "username": { "type": "string", "description": "Instagram username" }, "full_name": { "type": "string", "description": "Display name; empty string if none" }, "is_verified": { "type": "boolean", "description": "Account has verified badge" }, "profile_pic_url": { "type": [ "string", "null" ], "description": "Profile picture URL" }, "follower_count": { "type": [ "integer", "null" ], "description": "Number of followers" }, "reels": { "type": "array", "items": { "type": "object", "properties": { "shortcode": { "type": "string", "description": "Reel shortcode (URL code)" }, "link": { "type": "string", "description": "Reel URL (https://www.instagram.com/reel//)" }, "owner_id": { "type": [ "string", "null" ], "description": "Numeric user ID of the reel's owner; differs from id for collab reels" }, "thumbnail_url": { "type": [ "string", "null" ], "description": "Cover image URL" }, "taken_at": { "type": [ "integer", "null" ], "description": "Approximate publish time, Unix seconds (decoded from the media ID; usually a few minutes early)" }, "like_count": { "type": [ "integer", "null" ], "description": "Number of likes" }, "comment_count": { "type": [ "integer", "null" ], "description": "Number of comments" }, "view_count": { "type": [ "integer", "null" ], "description": "Plays" }, "like_and_view_counts_disabled": { "type": [ "boolean", "null" ], "description": "Owner hid counts; like/view counts unreliable" }, "is_pinned": { "type": "boolean", "description": "Pinned to the top of this profile's Reels tab" } }, "required": [ "shortcode", "link", "is_pinned" ] }, "description": "Reels in the order of the profile's Reels tab (newest first), max limit" }, "reels_fetched": { "type": "integer", "description": "Number of reels returned" }, "has_more": { "type": "boolean", "description": "More reels exist beyond those returned" } }, "required": [ "id", "username", "full_name", "is_verified", "reels", "reels_fetched", "has_more" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/instagram/reels_search": { "post": { "operationId": "instagram_reels_search", "summary": "Instagram reels search", "description": "Find Instagram reels for a keyword through search-engine results, then open each reel for its owner, caption, likes, comments, views, duration, audio, cover image and MP4 link.\n\n- Instagram's own search needs a login, so reels are found through a public search engine's index (DuckDuckGo, query site:instagram.com/reel ). Coverage, freshness and order follow that index, not Instagram: new reels show up with a delay and popular reels are not guaranteed.\n- date_posted uses the date the search engine assigns to each page, which is usually but not always the posting date. Check taken_at for the exact publish time.\n- Up to limit reels are opened on Instagram one by one, so a call can take 10-30 seconds. A reel that cannot be read stays in the list with its search_title and search_snippet, details_available false and the reason in details_error.\n- video_url is a signed CDN link that stops working at video_url_expires_at, usually within a few days. Download it before then, for example: curl -L -o reel.mp4 \"\"\n- page above 1 needs an extra search request and is blocked by the search engine more often. If the search engine blocks the request, or Instagram blocks every reel on the page, the call fails (usually TARGET_BLOCKED) and the credits are refunded.\n\nCost: 3 credits per successful request.", "tags": [ "Instagram" ], "x-credits": 3, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/instagram#instagram-reels_search" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "query": { "type": "string", "description": "Keyword or phrase to search for, 1-100 characters. site: and !bang operators are ignored.", "examples": [ "dogs" ] }, "date_posted": { "type": "string", "description": "Only reels the search engine dates within this window: last-week, last-month or last-year. Omit for any time.", "examples": [ "last-month" ] }, "page": { "type": "integer", "description": "Search results page, about 10 reels per page. Values outside 1-10 are rejected.", "examples": [ 1 ], "default": 1, "minimum": 1, "maximum": 10 }, "limit": { "type": "integer", "description": "How many of the page's reels to open for full details.", "examples": [ 10 ], "default": 10, "minimum": 1, "maximum": 10 }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [ "query" ] }, "example": { "query": "dogs", "date_posted": "last-month" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "query": { "type": "string", "description": "Query as searched (whitespace-collapsed, site: operators removed)" }, "date_posted": { "type": [ "string", "null" ], "description": "'last-week', 'last-month', 'last-year' or null (any time)" }, "page": { "type": "integer", "description": "Results page returned" }, "reels": { "type": "array", "items": { "type": "object", "properties": { "shortcode": { "type": "string", "description": "Reel shortcode (URL code)" }, "link": { "type": "string", "description": "Reel URL (https://www.instagram.com/reel//)" }, "details_available": { "type": "boolean", "description": "Reel page was read; false leaves the detail fields null" }, "details_error": { "type": [ "string", "null" ], "description": "Why details are missing: NOT_A_REEL, NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED, TARGET_BLOCKED, TIMEOUT, PARSE_ERROR or SKIPPED; null when details_available" }, "owner_username": { "type": [ "string", "null" ], "description": "Username of the reel owner" }, "caption": { "type": [ "string", "null" ], "description": "Caption, whitespace-collapsed (not truncated)" }, "like_count": { "type": [ "integer", "null" ], "description": "Number of likes" }, "comment_count": { "type": [ "integer", "null" ], "description": "Number of comments" }, "like_and_view_counts_disabled": { "type": [ "boolean", "null" ], "description": "Owner hid counts; like/view counts unreliable" }, "view_count": { "type": [ "integer", "null" ], "description": "Plays; null when Instagram does not expose them to logged-out visitors" }, "taken_at": { "type": [ "integer", "null" ], "description": "Publish time, Unix seconds" }, "duration_seconds": { "type": [ "number", "null" ], "description": "Video length in seconds, 2 decimals" }, "width": { "type": [ "integer", "null" ], "description": "Original video width in pixels" }, "height": { "type": [ "integer", "null" ], "description": "Original video height in pixels" }, "audio": { "type": [ "object", "null" ], "properties": { "title": { "type": "string", "description": "Song title, or the original audio title" }, "artist_name": { "type": [ "string", "null" ], "description": "Display artist for licensed music; null for original audio" }, "artist_username": { "type": [ "string", "null" ], "description": "Instagram username of the artist or of the original audio creator" }, "is_original": { "type": "boolean", "description": "Original audio by a creator (not licensed music)" } }, "required": [ "title", "is_original" ], "description": "Sound used in the reel; null if unknown" }, "thumbnail_url": { "type": [ "string", "null" ], "description": "Cover image URL" }, "video_url": { "type": [ "string", "null" ], "description": "MP4 file URL (signed CDN link, expires)" }, "video_url_expires_at": { "type": [ "string", "null" ], "description": "When video_url stops working, ISO 8601 (read from the signed link)" }, "search_title": { "type": [ "string", "null" ], "description": "Result title shown by the search engine" }, "search_snippet": { "type": [ "string", "null" ], "description": "Result snippet as indexed, usually ', - on : '" } }, "required": [ "shortcode", "link", "details_available" ] }, "description": "Reels in search-engine order, at most limit" }, "reels_found": { "type": "integer", "description": "Distinct reels found on this results page, before limit" }, "reels_fetched": { "type": "integer", "description": "Reels whose details were read (details_available true)" }, "has_more": { "type": "boolean", "description": "The search engine has another results page (request page + 1)" } }, "required": [ "query", "page", "reels", "reels_found", "reels_fetched", "has_more" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/x/profile": { "post": { "operationId": "x_profile", "summary": "X profile", "description": "Public X (Twitter) profile: bio, location, verification, follower/following/tweet/like/media/listed counts, avatar and banner.\n\n- created_at uses the X date format, for example \"Wed Jun 02 20:12:29 +0000 2010\".\n\nCost: 1 credit per successful request.", "tags": [ "X (Twitter)" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/x#x-profile" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "username": { "type": "string", "description": "X username, @handle or profile URL.", "examples": [ "tesla" ] }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [ "username" ] }, "example": { "username": "tesla" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "user_id": { "type": [ "string", "null" ], "description": "X numeric user ID (rest_id)" }, "username": { "type": "string", "description": "Screen name (canonical casing)" }, "full_name": { "type": "string", "description": "Display name" }, "biography": { "type": "string", "description": "Bio text; empty string if none" }, "location": { "type": "string", "description": "Profile location; empty string if none" }, "external_url": { "type": [ "string", "null" ], "description": "Expanded profile website URL" }, "is_private": { "type": "boolean", "description": "Tweets are protected" }, "is_verified": { "type": "boolean", "description": "Legacy verified OR blue-verified" }, "is_blue_verified": { "type": "boolean", "description": "Has X Premium (blue) checkmark" }, "follower_count": { "type": [ "integer", "null" ], "description": "Number of followers" }, "following_count": { "type": [ "integer", "null" ], "description": "Number of accounts followed" }, "tweet_count": { "type": [ "integer", "null" ], "description": "Total tweets incl. retweets" }, "like_count": { "type": [ "integer", "null" ], "description": "Tweets the user has liked" }, "media_count": { "type": [ "integer", "null" ], "description": "Number of media posts" }, "listed_count": { "type": [ "integer", "null" ], "description": "Number of lists including the user" }, "created_at": { "type": [ "string", "null" ], "description": "Join date, X legacy format" }, "profile_image_url": { "type": [ "string", "null" ], "description": "Full-size avatar URL" }, "profile_banner_url": { "type": [ "string", "null" ], "description": "Profile banner image URL" } }, "required": [ "username", "full_name", "biography", "location", "is_private", "is_verified", "is_blue_verified" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/x/posts": { "post": { "operationId": "x_posts", "summary": "X posts", "description": "An X profile plus its recent timeline (up to 60 tweets incl. pinned, retweets and own replies) with text, media and engagement counts.\n\n- Includes the pinned post, reposts and the account's own replies, up to 60 items.\n- For reposts the post fields describe the original post and retweeted_from holds its author.\n- Protected accounts return an empty posts array.\n\nCost: 2 credits per successful request.", "tags": [ "X (Twitter)" ], "x-credits": 2, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/x#x-posts" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "username": { "type": "string", "description": "X username, @handle or profile URL.", "examples": [ "tesla" ] }, "limit": { "type": "integer", "description": "Maximum number of tweets to return.", "examples": [ 20 ], "default": 20, "minimum": 1, "maximum": 60 }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [ "username" ] }, "example": { "username": "tesla", "limit": 20 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "user_id": { "type": [ "string", "null" ], "description": "X numeric user ID (rest_id)" }, "username": { "type": "string", "description": "Screen name (canonical casing)" }, "full_name": { "type": "string", "description": "Display name" }, "biography": { "type": "string", "description": "Bio text; empty string if none" }, "location": { "type": "string", "description": "Profile location; empty string if none" }, "external_url": { "type": [ "string", "null" ], "description": "Expanded profile website URL" }, "is_private": { "type": "boolean", "description": "Tweets are protected" }, "is_verified": { "type": "boolean", "description": "Legacy verified OR blue-verified" }, "is_blue_verified": { "type": "boolean", "description": "Has X Premium (blue) checkmark" }, "follower_count": { "type": [ "integer", "null" ], "description": "Number of followers" }, "following_count": { "type": [ "integer", "null" ], "description": "Number of accounts followed" }, "tweet_count": { "type": [ "integer", "null" ], "description": "Total tweets incl. retweets" }, "like_count": { "type": [ "integer", "null" ], "description": "Tweets the user has liked" }, "media_count": { "type": [ "integer", "null" ], "description": "Number of media posts" }, "listed_count": { "type": [ "integer", "null" ], "description": "Number of lists including the user" }, "created_at": { "type": [ "string", "null" ], "description": "Join date, X legacy format" }, "profile_image_url": { "type": [ "string", "null" ], "description": "Full-size avatar URL" }, "profile_banner_url": { "type": [ "string", "null" ], "description": "Profile banner image URL" }, "posts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Tweet ID (original tweet for retweets)" }, "link": { "type": [ "string", "null" ], "description": "https://x.com//status/" }, "text": { "type": "string", "description": "Full text (long-form note text if present)" }, "lang": { "type": [ "string", "null" ], "description": "Language code detected by X" }, "created_at": { "type": [ "string", "null" ], "description": "Post time, X legacy date format" }, "author_username": { "type": [ "string", "null" ], "description": "Author screen name (original author for RTs)" }, "is_pinned": { "type": "boolean", "description": "Tweet is the pinned tweet" }, "is_retweet": { "type": "boolean", "description": "Entry is a retweet" }, "retweeted_from": { "type": [ "string", "null" ], "description": "Original author's username when retweet" }, "is_reply": { "type": "boolean", "description": "Tweet is a reply" }, "in_reply_to": { "type": [ "string", "null" ], "description": "Screen name being replied to" }, "is_quote": { "type": "boolean", "description": "Tweet quotes another tweet" }, "quoted": { "type": [ "object", "null" ], "properties": { "id": { "type": [ "string", "null" ], "description": "Quoted tweet ID" }, "username": { "type": [ "string", "null" ], "description": "Quoted tweet author" }, "text": { "type": "string", "description": "Quoted tweet text" }, "link": { "type": [ "string", "null" ], "description": "Quoted tweet URL" } }, "required": [ "text" ], "description": "Quoted tweet summary" }, "reply_count": { "type": [ "integer", "null" ], "description": "Number of replies" }, "retweet_count": { "type": [ "integer", "null" ], "description": "Number of retweets" }, "quote_count": { "type": [ "integer", "null" ], "description": "Number of quote tweets" }, "like_count": { "type": [ "integer", "null" ], "description": "Number of likes" }, "bookmark_count": { "type": [ "integer", "null" ], "description": "Number of bookmarks" }, "view_count": { "type": [ "integer", "null" ], "description": "Number of views" }, "media": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "'photo', 'video' or 'animated_gif'" }, "image_url": { "type": [ "string", "null" ], "description": "Image or video thumbnail URL" }, "video_url": { "type": [ "string", "null" ], "description": "Highest-bitrate MP4 URL" }, "duration_ms": { "type": [ "integer", "null" ], "description": "Video duration in milliseconds" }, "width": { "type": [ "integer", "null" ], "description": "Original width in pixels" }, "height": { "type": [ "integer", "null" ], "description": "Original height in pixels" } }, "required": [ "type" ] }, "description": "Attached media; empty array if none" } }, "required": [ "id", "text", "is_pinned", "is_retweet", "is_reply", "is_quote", "media" ] }, "description": "Timeline tweets in timeline order, max limit" }, "posts_fetched": { "type": "integer", "description": "Number of tweets returned" }, "has_more": { "type": "boolean", "description": "More tweets exist beyond those returned" } }, "required": [ "username", "full_name", "biography", "location", "is_private", "is_verified", "is_blue_verified", "posts", "posts_fetched", "has_more" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/x/post": { "post": { "operationId": "x_post", "summary": "X post", "description": "A single X post (tweet) by URL or ID: text, author, reply/quote/retweet info, media and engagement counts including views.\n\n- Send id as a string. Post IDs are larger than JSON numbers can hold exactly; numeric IDs are rejected.\n\nCost: 1 credit per successful request.", "tags": [ "X (Twitter)" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/x#x-post" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string", "description": "Tweet URL (a bare tweet ID also works).", "examples": [ "https://x.com/jack/status/20" ] }, "id": { "type": "string", "description": "Tweet ID; used only when url is empty.", "examples": [ "20" ] }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [], "anyOf": [ { "required": [ "url" ] }, { "required": [ "id" ] } ] }, "example": { "url": "https://x.com/jack/status/20" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Tweet ID (original tweet if a retweet)" }, "link": { "type": [ "string", "null" ], "description": "https://x.com//status/" }, "text": { "type": "string", "description": "Full text (long-form note text if present)" }, "lang": { "type": [ "string", "null" ], "description": "Language code detected by X" }, "created_at": { "type": [ "string", "null" ], "description": "Post time, X legacy date format" }, "author_username": { "type": [ "string", "null" ], "description": "Author screen name" }, "is_pinned": { "type": "boolean", "description": "Always false for this endpoint" }, "is_retweet": { "type": "boolean", "description": "Tweet is a retweet" }, "retweeted_from": { "type": [ "string", "null" ], "description": "Original author's username when retweet" }, "is_reply": { "type": "boolean", "description": "Tweet is a reply" }, "in_reply_to": { "type": [ "string", "null" ], "description": "Screen name being replied to" }, "is_quote": { "type": "boolean", "description": "Tweet quotes another tweet" }, "quoted": { "type": [ "object", "null" ], "properties": { "id": { "type": [ "string", "null" ], "description": "Quoted tweet ID" }, "username": { "type": [ "string", "null" ], "description": "Quoted tweet author" }, "text": { "type": "string", "description": "Quoted tweet text" }, "link": { "type": [ "string", "null" ], "description": "Quoted tweet URL" } }, "required": [ "text" ], "description": "Quoted tweet summary" }, "reply_count": { "type": [ "integer", "null" ], "description": "Number of replies" }, "retweet_count": { "type": [ "integer", "null" ], "description": "Number of retweets" }, "quote_count": { "type": [ "integer", "null" ], "description": "Number of quote tweets" }, "like_count": { "type": [ "integer", "null" ], "description": "Number of likes" }, "bookmark_count": { "type": [ "integer", "null" ], "description": "Number of bookmarks" }, "view_count": { "type": [ "integer", "null" ], "description": "Number of views" }, "media": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "'photo', 'video' or 'animated_gif'" }, "image_url": { "type": [ "string", "null" ], "description": "Image (original size, name=orig) or video thumbnail URL" }, "video_url": { "type": [ "string", "null" ], "description": "Highest-bitrate MP4 URL" }, "duration_ms": { "type": [ "integer", "null" ], "description": "Video duration in milliseconds" }, "width": { "type": [ "integer", "null" ], "description": "Original width in pixels" }, "height": { "type": [ "integer", "null" ], "description": "Original height in pixels" } }, "required": [ "type" ] }, "description": "Attached media; empty array if none" } }, "required": [ "id", "text", "is_pinned", "is_retweet", "is_reply", "is_quote", "media" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/tiktok/profile": { "post": { "operationId": "tiktok_profile", "summary": "TikTok profile", "description": "Public TikTok profile: nickname, bio, link, verification, follower/following/like/video counts, avatar, region and creation date.\n\nCost: 1 credit per successful request.", "tags": [ "TikTok" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/tiktok#tiktok-profile" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "username": { "type": "string", "description": "TikTok username, @handle or profile URL.", "examples": [ "khaby.lame" ] }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [ "username" ] }, "example": { "username": "khaby.lame" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "user_id": { "type": [ "string", "null" ], "description": "TikTok numeric user ID" }, "username": { "type": "string", "description": "Unique username (uniqueId)" }, "full_name": { "type": "string", "description": "Display name (nickname)" }, "biography": { "type": "string", "description": "Bio text (signature)" }, "external_url": { "type": [ "string", "null" ], "description": "Bio link URL" }, "is_private": { "type": "boolean", "description": "Account is private" }, "is_verified": { "type": "boolean", "description": "Account has verified badge" }, "follower_count": { "type": [ "integer", "null" ], "description": "Number of followers" }, "following_count": { "type": [ "integer", "null" ], "description": "Number of accounts followed" }, "like_count": { "type": [ "integer", "null" ], "description": "Total likes (hearts) received" }, "video_count": { "type": [ "integer", "null" ], "description": "Number of videos posted" }, "profile_image_url": { "type": [ "string", "null" ], "description": "Largest available avatar URL" }, "region": { "type": [ "string", "null" ], "description": "Account region code" }, "created_at": { "type": [ "string", "null" ], "description": "Account creation time, ISO 8601" } }, "required": [ "username", "full_name", "biography", "is_private", "is_verified" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/tiktok/posts": { "post": { "operationId": "tiktok_posts", "summary": "TikTok videos", "description": "A TikTok profile summary plus its newest videos (max 12, from the public embed) with cover, play URL and play count.\n\n- Returns the newest videos (up to 12) with play counts. Use tiktok.video for full per-video stats.\n- The profile block uses nickname, signature, heart_count and avatar_url.\n\nCost: 1 credit per successful request.", "tags": [ "TikTok" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/tiktok#tiktok-posts" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "username": { "type": "string", "description": "TikTok username, @handle or profile URL.", "examples": [ "khaby.lame" ] }, "limit": { "type": "integer", "description": "Maximum number of videos to return.", "examples": [ 12 ], "default": 12, "minimum": 1, "maximum": 12 }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [ "username" ] }, "example": { "username": "khaby.lame", "limit": 12 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "user_id": { "type": [ "string", "null" ], "description": "TikTok numeric user ID" }, "username": { "type": "string", "description": "Unique username (uniqueId)" }, "nickname": { "type": "string", "description": "Display name" }, "signature": { "type": "string", "description": "Bio text" }, "is_verified": { "type": "boolean", "description": "Account has verified badge" }, "is_private": { "type": "boolean", "description": "Account is private" }, "follower_count": { "type": [ "integer", "null" ], "description": "Number of followers" }, "following_count": { "type": [ "integer", "null" ], "description": "Number of accounts followed" }, "heart_count": { "type": [ "integer", "null" ], "description": "Total likes (hearts) received" }, "avatar_url": { "type": [ "string", "null" ], "description": "Avatar thumbnail URL" }, "posts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Video ID" }, "link": { "type": "string", "description": "Video URL on tiktok.com" }, "description": { "type": "string", "description": "Video caption" }, "cover_url": { "type": [ "string", "null" ], "description": "Cover image URL" }, "origin_cover_url": { "type": [ "string", "null" ], "description": "Original cover image URL" }, "dynamic_cover_url": { "type": [ "string", "null" ], "description": "Animated cover URL" }, "play_url": { "type": [ "string", "null" ], "description": "Video playback URL (expiring CDN link)" }, "play_count": { "type": [ "integer", "null" ], "description": "Number of plays" }, "width": { "type": [ "integer", "null" ], "description": "Video width in pixels" }, "height": { "type": [ "integer", "null" ], "description": "Video height in pixels" }, "ratio": { "type": [ "string", "null" ], "description": "Resolution/ratio label from TikTok" }, "is_private": { "type": "boolean", "description": "Video is private" } }, "required": [ "id", "link", "description", "is_private" ] }, "description": "Newest videos from the embed, max limit" }, "posts_fetched": { "type": "integer", "description": "Number of videos returned" }, "has_more": { "type": "boolean", "description": "Embed list had more than limit" } }, "required": [ "username", "nickname", "signature", "is_verified", "is_private", "posts", "posts_fetched", "has_more" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/tiktok/video": { "post": { "operationId": "tiktok_video", "summary": "TikTok video", "description": "A single TikTok video by URL, short link or ID: caption, timestamp, like/comment/share/play/save counts, cover, duration, the MP4 file (without watermark when available), author and music with its audio file.\n\n- Short share links (vm.tiktok.com, vt.tiktok.com, tiktok.com/t/...) are resolved to the video first.\n- Send id as a string.\n\nCost: 1 credit per successful request.", "tags": [ "TikTok" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/tiktok#tiktok-video" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string", "description": "TikTok video URL, or a short share link (vm.tiktok.com/..., tiktok.com/t/...).", "examples": [ "https://www.tiktok.com/@scout2015/video/6718335390845095173" ] }, "video": { "type": "string", "description": "Alias of url (URL or ID).", "examples": [ "https://www.tiktok.com/embed/v2/6718335390845095173" ] }, "id": { "type": "string", "description": "Numeric video ID.", "examples": [ "6718335390845095173" ] }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [], "anyOf": [ { "required": [ "url" ] }, { "required": [ "video" ] }, { "required": [ "id" ] } ] }, "example": { "url": "https://www.tiktok.com/@scout2015/video/6718335390845095173" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Video ID" }, "link": { "type": [ "string", "null" ], "description": "Video URL on tiktok.com" }, "description": { "type": "string", "description": "Video caption" }, "created_at": { "type": [ "string", "null" ], "description": "Publish time, ISO 8601" }, "like_count": { "type": [ "integer", "null" ], "description": "Number of likes" }, "comment_count": { "type": [ "integer", "null" ], "description": "Number of comments" }, "share_count": { "type": [ "integer", "null" ], "description": "Number of shares" }, "play_count": { "type": [ "integer", "null" ], "description": "Number of plays" }, "save_count": { "type": [ "integer", "null" ], "description": "Number of saves (collects)" }, "cover_url": { "type": [ "string", "null" ], "description": "Cover image URL" }, "dynamic_cover_url": { "type": [ "string", "null" ], "description": "Animated cover URL" }, "duration": { "type": [ "integer", "null" ], "description": "Video duration in seconds" }, "video_url": { "type": [ "string", "null" ], "description": "MP4 video file, without the TikTok watermark when available (signed CDN link, expires within hours)" }, "video_has_watermark": { "type": [ "boolean", "null" ], "description": "true when only the watermarked file was available; null when there is no video file" }, "width": { "type": [ "integer", "null" ], "description": "Video width in pixels" }, "height": { "type": [ "integer", "null" ], "description": "Video height in pixels" }, "author": { "type": "object", "properties": { "user_id": { "type": [ "string", "null" ], "description": "Author numeric user ID" }, "username": { "type": "string", "description": "Author unique username" }, "nickname": { "type": "string", "description": "Author display name" }, "signature": { "type": "string", "description": "Author bio text" }, "is_verified": { "type": "boolean", "description": "Author has verified badge" }, "avatar_url": { "type": [ "string", "null" ], "description": "Author avatar URL" } }, "required": [ "username", "nickname", "signature", "is_verified" ], "description": "Video author" }, "music": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "description": "Music/sound ID" }, "title": { "type": "string", "description": "Sound title" }, "author": { "type": "string", "description": "Sound author name" }, "is_original": { "type": "boolean", "description": "Original sound by the creator" }, "play_url": { "type": [ "string", "null" ], "description": "Audio file of the sound (signed CDN link, expires within hours)" }, "cover_url": { "type": [ "string", "null" ], "description": "Sound cover image URL" } }, "required": [ "title", "author", "is_original" ], "description": "Sound used in the video" } }, "required": [ "id", "description", "author", "music" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/tiktok/comments": { "post": { "operationId": "tiktok_comments", "summary": "TikTok video comments", "description": "Top-level comments on a TikTok video by URL or ID: text, likes, reply count, time, pinned and creator-liked flags and the commenter, plus the video's total comment count. Up to 100 comments.\n\n- Replies are not included; reply_count shows how many each comment has.\n- TikTok hides some comments, so fewer than comment_count may be returned.\n- A video with comments turned off returns 404 with code COMMENTS_DISABLED. A video without comments returns an empty list.\n- Short share links (vm.tiktok.com, vt.tiktok.com, tiktok.com/t/...) are resolved to the video first. Send id as a string.\n\nCost: 1 credit per successful request.", "tags": [ "TikTok" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/tiktok#tiktok-comments" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string", "description": "TikTok video URL, or a short share link (vm.tiktok.com/..., tiktok.com/t/...).", "examples": [ "https://www.tiktok.com/@khaby.lame/video/7694335322922044703" ] }, "id": { "type": "string", "description": "Numeric video ID.", "examples": [ "7694335322922044703" ] }, "limit": { "type": "integer", "description": "Maximum number of comments to return.", "examples": [ 20 ], "default": 20, "minimum": 1, "maximum": 100 }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [], "anyOf": [ { "required": [ "url" ] }, { "required": [ "id" ] } ] }, "example": { "url": "https://www.tiktok.com/@khaby.lame/video/7694335322922044703", "limit": 20 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "video_id": { "type": "string", "description": "Video ID" }, "comment_count": { "type": [ "integer", "null" ], "description": "Total comments on the video as reported by TikTok" }, "comments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Comment ID" }, "text": { "type": "string", "description": "Comment text" }, "like_count": { "type": [ "integer", "null" ], "description": "Number of likes" }, "reply_count": { "type": [ "integer", "null" ], "description": "Number of replies" }, "created_at": { "type": [ "string", "null" ], "description": "Comment time, ISO 8601" }, "is_author_liked": { "type": "boolean", "description": "Liked by the video's creator" }, "is_pinned": { "type": "boolean", "description": "Pinned by the video's creator" }, "language": { "type": [ "string", "null" ], "description": "Detected comment language code" }, "image_url": { "type": [ "string", "null" ], "description": "Attached image URL (image comments)" }, "author": { "type": "object", "properties": { "user_id": { "type": [ "string", "null" ], "description": "Commenter numeric user ID" }, "username": { "type": "string", "description": "Commenter unique username" }, "nickname": { "type": "string", "description": "Commenter display name" }, "avatar_url": { "type": [ "string", "null" ], "description": "Commenter avatar URL" }, "is_verified": { "type": "boolean", "description": "Commenter has verified badge" } }, "required": [ "username", "nickname", "is_verified" ], "description": "Commenter" } }, "required": [ "id", "text", "is_author_liked", "is_pinned", "author" ] }, "description": "Top-level comments in TikTok's relevance order, max limit" }, "comments_fetched": { "type": "integer", "description": "Number of comments returned" }, "has_more": { "type": "boolean", "description": "More comments exist beyond those returned" } }, "required": [ "video_id", "comments", "comments_fetched", "has_more" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/tiktok/transcript": { "post": { "operationId": "tiktok_transcript", "summary": "TikTok video transcript", "description": "Timestamped transcript of a TikTok video from its captions (auto-generated or creator-added), with the caption languages available. Pick a language with lang.\n\n- Only videos with captions have a transcript. Others, and languages not offered, return 404 with code NO_TRANSCRIPT.\n- Times are in seconds, rounded to 2 decimals.\n- Short share links (vm.tiktok.com, vt.tiktok.com, tiktok.com/t/...) are resolved to the video first. Send id as a string.\n\nCost: 1 credit per successful request.", "tags": [ "TikTok" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/tiktok#tiktok-transcript" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string", "description": "TikTok video URL, or a short share link (vm.tiktok.com/..., tiktok.com/t/...).", "examples": [ "https://www.tiktok.com/@esan_doctor/video/7696087114202647826" ] }, "id": { "type": "string", "description": "Numeric video ID.", "examples": [ "7696087114202647826" ] }, "lang": { "type": "string", "description": "Caption language: a code like en or es, or TikTok's code like eng-US. Defaults to the video's original language.", "examples": [ "en" ] }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [], "anyOf": [ { "required": [ "url" ] }, { "required": [ "id" ] } ] }, "example": { "url": "https://www.tiktok.com/@esan_doctor/video/7696087114202647826" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "video_id": { "type": "string", "description": "Video ID" }, "language": { "type": "string", "description": "TikTok language code of the returned captions, e.g. eng-US" }, "is_auto_generated": { "type": [ "boolean", "null" ], "description": "Captions were generated automatically (speech recognition or machine translation)" }, "available_languages": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "TikTok language code, e.g. eng-US" }, "is_auto_generated": { "type": [ "boolean", "null" ], "description": "Captions in this language were generated automatically" } }, "required": [ "code" ] }, "description": "Caption languages available for the video" }, "segments": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "number", "description": "Start time in seconds" }, "duration": { "type": "number", "description": "Duration in seconds" }, "text": { "type": "string", "description": "Caption text" } }, "required": [ "start", "duration", "text" ] }, "description": "Caption lines in order" }, "text": { "type": "string", "description": "Full transcript as one string" }, "segment_count": { "type": "integer", "description": "Number of segments" } }, "required": [ "video_id", "language", "available_languages", "segments", "text", "segment_count" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/tiktok/music": { "post": { "operationId": "tiktok_music", "summary": "TikTok sound", "description": "A TikTok sound by URL or ID: title, artist, duration, original-sound flag, cover, audio URL and how many videos use it, plus the top videos using it (max 12, from the public embed).\n\n- Returns the top videos (up to 12) that TikTok's public embed shows; video_count is the full total.\n- Video items use the same fields as tiktok.posts plus author_username.\n- title, duration, is_original and play_url are read from the first video and are null if TikTok does not return it.\n\nCost: 2 credits per successful request.", "tags": [ "TikTok" ], "x-credits": 2, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/tiktok#tiktok-music" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string", "description": "TikTok sound URL (tiktok.com/music/...).", "examples": [ "https://www.tiktok.com/music/original-sound-7694335437137087262" ] }, "id": { "type": "string", "description": "Numeric sound (music) ID.", "examples": [ "7694335437137087262" ] }, "limit": { "type": "integer", "description": "Maximum number of videos to return.", "examples": [ 12 ], "default": 12, "minimum": 1, "maximum": 12 }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [], "anyOf": [ { "required": [ "url" ] }, { "required": [ "id" ] } ] }, "example": { "url": "https://www.tiktok.com/music/original-sound-7694335437137087262", "limit": 12 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Sound (music) ID" }, "title": { "type": [ "string", "null" ], "description": "Sound title" }, "author": { "type": [ "string", "null" ], "description": "Sound author or artist name" }, "album": { "type": [ "string", "null" ], "description": "Album name (licensed music)" }, "duration": { "type": [ "integer", "null" ], "description": "Sound duration in seconds" }, "is_original": { "type": [ "boolean", "null" ], "description": "Original sound made by a creator" }, "cover_url": { "type": [ "string", "null" ], "description": "Sound cover image URL" }, "play_url": { "type": [ "string", "null" ], "description": "Audio URL (expiring CDN link)" }, "video_count": { "type": [ "integer", "null" ], "description": "Number of videos using the sound" }, "link": { "type": "string", "description": "Sound URL on tiktok.com" }, "videos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Video ID" }, "link": { "type": "string", "description": "Video URL on tiktok.com" }, "description": { "type": "string", "description": "Video caption" }, "cover_url": { "type": [ "string", "null" ], "description": "Cover image URL" }, "origin_cover_url": { "type": [ "string", "null" ], "description": "Original cover image URL" }, "dynamic_cover_url": { "type": [ "string", "null" ], "description": "Animated cover URL" }, "play_url": { "type": [ "string", "null" ], "description": "Video playback URL (expiring CDN link)" }, "play_count": { "type": [ "integer", "null" ], "description": "Number of plays" }, "width": { "type": [ "integer", "null" ], "description": "Video width in pixels" }, "height": { "type": [ "integer", "null" ], "description": "Video height in pixels" }, "ratio": { "type": [ "string", "null" ], "description": "Resolution/ratio label from TikTok" }, "is_private": { "type": "boolean", "description": "Video is private" }, "author_username": { "type": [ "string", "null" ], "description": "Username of the video's creator" } }, "required": [ "id", "link", "description", "is_private" ] }, "description": "Top videos using the sound from the embed, max limit" }, "videos_fetched": { "type": "integer", "description": "Number of videos returned" }, "has_more": { "type": "boolean", "description": "Embed list had more than limit" } }, "required": [ "id", "link", "videos", "videos_fetched", "has_more" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/tiktok/hashtag": { "post": { "operationId": "tiktok_hashtag", "summary": "TikTok hashtag stats", "description": "TikTok hashtag stats: ID, title, description, total video and view counts, and cover image.\n\n- Returns hashtag stats only, not the hashtag's videos.\n- Hashtags are matched case-insensitively.\n\nCost: 1 credit per successful request.", "tags": [ "TikTok" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/tiktok#tiktok-hashtag" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "hashtag": { "type": "string", "description": "Hashtag with or without #, or a tiktok.com/tag/... URL.", "examples": [ "learnfromkhaby" ] }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [ "hashtag" ] }, "example": { "hashtag": "learnfromkhaby" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "description": "Hashtag (challenge) ID" }, "title": { "type": "string", "description": "Hashtag name without #" }, "description": { "type": "string", "description": "Hashtag description" }, "link": { "type": [ "string", "null" ], "description": "Hashtag page URL on tiktok.com" }, "video_count": { "type": [ "integer", "null" ], "description": "Number of videos with the hashtag" }, "view_count": { "type": [ "integer", "null" ], "description": "Total views of those videos" }, "cover_url": { "type": [ "string", "null" ], "description": "Hashtag cover image URL" }, "is_commerce": { "type": "boolean", "description": "Branded (commercial) hashtag" } }, "required": [ "title", "description", "is_commerce" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/youtube/profile": { "post": { "operationId": "youtube_profile", "summary": "YouTube channel", "description": "YouTube channel info by handle, channel ID or URL: title, description, approximate subscriber/video counts, avatar and banner.\n\n- Subscriber and video counts are YouTube's rounded figures (for example 521M).\n- Legacy /user/ and /c/ links are not supported. Use the @handle or the channel ID (UC...).\n\nCost: 1 credit per successful request.", "tags": [ "YouTube" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/youtube#youtube-profile" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "username": { "type": "string", "description": "Channel @handle, handle, channel ID or channel URL.", "examples": [ "@MrBeast" ] }, "channel": { "type": "string", "description": "Alias of username (same accepted formats).", "examples": [ "UCX6OQ3DkcsbYNE6H8uQQuVA" ] }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [], "anyOf": [ { "required": [ "username" ] }, { "required": [ "channel" ] } ] }, "example": { "username": "@MrBeast" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "channel_id": { "type": [ "string", "null" ], "description": "Channel ID (UC...)" }, "handle": { "type": [ "string", "null" ], "description": "Channel handle including '@'" }, "title": { "type": "string", "description": "Channel name" }, "description": { "type": "string", "description": "Channel description" }, "keywords": { "type": "string", "description": "Channel keywords as one string" }, "subscriber_count": { "type": [ "integer", "null" ], "description": "Approximate subscribers parsed from rounded text" }, "subscriber_count_text": { "type": [ "string", "null" ], "description": "Raw text, e.g. '521M subscribers'" }, "video_count": { "type": [ "integer", "null" ], "description": "Approximate video count from rounded text" }, "video_count_text": { "type": [ "string", "null" ], "description": "Raw text, e.g. '1K videos'" }, "is_family_safe": { "type": "boolean", "description": "Channel flagged family safe" }, "channel_url": { "type": [ "string", "null" ], "description": "Vanity or canonical channel URL" }, "avatar_url": { "type": [ "string", "null" ], "description": "Largest avatar image URL" }, "banner_url": { "type": [ "string", "null" ], "description": "Largest banner image URL" }, "available_countries": { "type": [ "integer", "null" ], "description": "COUNT of available country codes" } }, "required": [ "title", "description", "keywords", "is_family_safe" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/youtube/videos": { "post": { "operationId": "youtube_videos", "summary": "YouTube videos", "description": "A YouTube channel summary plus its latest uploads (max 30) with title, approximate views, relative publish time, duration and thumbnail, with the channel header (handle, description, banner, video count).\n\n- Returns up to 30 latest uploads. View counts are approximate and publish times are relative, for example \"2 days ago\".\n\nCost: 1 credit per successful request.", "tags": [ "YouTube" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/youtube#youtube-videos" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "username": { "type": "string", "description": "Channel @handle, handle, channel ID or channel URL.", "examples": [ "MrBeast" ] }, "channel": { "type": "string", "description": "Alias of username (same accepted formats).", "examples": [ "UCX6OQ3DkcsbYNE6H8uQQuVA" ] }, "limit": { "type": "integer", "description": "Maximum number of videos to return.", "examples": [ 5 ], "default": 12, "minimum": 1, "maximum": 30 }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [], "anyOf": [ { "required": [ "username" ] }, { "required": [ "channel" ] } ] }, "example": { "username": "MrBeast", "limit": 5 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "channel_id": { "type": [ "string", "null" ], "description": "Channel ID (UC...)" }, "title": { "type": "string", "description": "Channel name" }, "channel_url": { "type": [ "string", "null" ], "description": "Vanity or canonical channel URL" }, "avatar_url": { "type": [ "string", "null" ], "description": "Largest avatar image URL" }, "subscriber_count": { "type": [ "integer", "null" ], "description": "Approximate subscribers from rounded text" }, "subscriber_count_text": { "type": [ "string", "null" ], "description": "Raw text, e.g. '521M subscribers'" }, "handle": { "type": [ "string", "null" ], "description": "Channel handle including '@'" }, "description": { "type": "string", "description": "Channel description" }, "keywords": { "type": "string", "description": "Channel keywords as one string" }, "video_count": { "type": [ "integer", "null" ], "description": "Approximate video count from rounded text" }, "video_count_text": { "type": [ "string", "null" ], "description": "Raw text, e.g. '1K videos'" }, "is_family_safe": { "type": "boolean", "description": "Channel flagged family safe" }, "banner_url": { "type": [ "string", "null" ], "description": "Largest banner image URL" }, "available_countries": { "type": [ "integer", "null" ], "description": "COUNT of available country codes" }, "videos_fetched": { "type": "integer", "description": "Number of videos returned" }, "has_more": { "type": "boolean", "description": "First page held more than limit" }, "videos": { "type": "array", "items": { "type": "object", "properties": { "video_id": { "type": "string", "description": "11-char video ID" }, "link": { "type": "string", "description": "Watch URL" }, "title": { "type": "string", "description": "Video title" }, "view_count": { "type": [ "integer", "null" ], "description": "Approximate views from rounded text" }, "view_count_text": { "type": [ "string", "null" ], "description": "Raw text, e.g. '74M views'" }, "published_text": { "type": [ "string", "null" ], "description": "Relative time, e.g. '12 days ago'" }, "duration_text": { "type": [ "string", "null" ], "description": "Duration badge, e.g. '32:15'" }, "duration_seconds": { "type": [ "integer", "null" ], "description": "Duration in seconds" }, "thumbnail_url": { "type": [ "string", "null" ], "description": "Largest thumbnail URL" } }, "required": [ "video_id", "link", "title" ] }, "description": "Latest uploads from Videos tab, max limit" } }, "required": [ "title", "description", "keywords", "is_family_safe", "videos_fetched", "has_more", "videos" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/youtube/video": { "post": { "operationId": "youtube_video", "summary": "YouTube video", "description": "A single YouTube video by URL or ID: title, description, exact views, likes, duration, publish date, category, keywords and channel.\n\n- View and like counts are exact.\n- is_live is also true for recordings of finished live streams.\n\nCost: 1 credit per successful request.", "tags": [ "YouTube" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/youtube#youtube-video" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string", "description": "YouTube video URL (a bare ID also works).", "examples": [ "https://www.youtube.com/watch?v=jNQXAC9IVRw" ] }, "id": { "type": "string", "description": "11-character video ID.", "examples": [ "0e3GPea1Tyg" ] }, "video": { "type": "string", "description": "Alias (URL or ID).", "examples": [ "https://youtu.be/dQw4w9WgXcQ" ] }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [], "anyOf": [ { "required": [ "url" ] }, { "required": [ "id" ] }, { "required": [ "video" ] } ] }, "example": { "url": "https://www.youtube.com/watch?v=jNQXAC9IVRw" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "video_id": { "type": "string", "description": "11-char video ID" }, "link": { "type": "string", "description": "Canonical watch URL" }, "title": { "type": "string", "description": "Video title" }, "description": { "type": "string", "description": "Full video description" }, "duration_seconds": { "type": [ "integer", "null" ], "description": "Duration in seconds" }, "view_count": { "type": [ "integer", "null" ], "description": "Exact view count" }, "like_count": { "type": [ "integer", "null" ], "description": "Like count from microformat" }, "published_at": { "type": [ "string", "null" ], "description": "Publish date from microformat (ISO)" }, "category": { "type": [ "string", "null" ], "description": "YouTube category name" }, "is_live": { "type": "boolean", "description": "Video is/was live-stream content" }, "is_family_safe": { "type": [ "boolean", "null" ], "description": "Flagged family safe" }, "playability": { "type": [ "string", "null" ], "description": "Playability status, e.g. 'OK', 'LOGIN_REQUIRED'" }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "Video tags, max 100" }, "thumbnail_url": { "type": [ "string", "null" ], "description": "Largest thumbnail URL" }, "thumbnails": { "type": "array", "items": { "type": "object", "properties": { "quality": { "type": "string", "description": "'maxres', 'sd', 'hq', 'mq' or 'default'" }, "url": { "type": "string", "description": "JPG URL" }, "width": { "type": "integer", "description": "Width in pixels" }, "height": { "type": "integer", "description": "Height in pixels" } }, "required": [ "quality", "url", "width", "height" ] }, "description": "Every standard thumbnail size on i.ytimg.com, largest first (maxres is missing for some low-resolution uploads)" }, "channel": { "type": "object", "properties": { "channel_id": { "type": [ "string", "null" ], "description": "Channel ID (UC...)" }, "name": { "type": "string", "description": "Channel name" }, "handle": { "type": [ "string", "null" ], "description": "Channel handle including '@'" }, "url": { "type": [ "string", "null" ], "description": "Channel URL" } }, "required": [ "name" ], "description": "Uploading channel" } }, "required": [ "video_id", "link", "title", "description", "is_live", "keywords", "thumbnails", "channel" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/youtube/search": { "post": { "operationId": "youtube_search", "summary": "YouTube search", "description": "Search YouTube by keyword: videos, Shorts, channels and playlists with views, publish time, duration and channel. Optional type, popularity sort and upload-date filters.\n\n- Results are fetched in pages of about 20 (up to 3 pages for limit 50).\n- Sorting by upload date or rating is not available: YouTube removed those sorts and ignores them. Use upload_date to restrict recency; popularity is YouTube's own ranking, not a strict view-count order.\n- With type all, YouTube's Shorts shelves are skipped; use type shorts to get Shorts. Shorts from shelves have no channel, publish time or duration.\n\nCost: 1 credit per successful request.", "tags": [ "YouTube" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/youtube#youtube-search" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "query": { "type": "string", "description": "Search keywords (max 200 characters).", "examples": [ "lofi hip hop" ] }, "type": { "type": "string", "description": "Result type: all, video, shorts, channel or playlist. Default all.", "examples": [ "video" ] }, "sort": { "type": "string", "description": "relevance or popularity (view_count is accepted as an alias). Default relevance.", "examples": [ "popularity" ] }, "upload_date": { "type": "string", "description": "Only results uploaded within: today, week, month or year.", "examples": [ "week" ] }, "limit": { "type": "integer", "description": "Maximum number of results to return.", "examples": [ 10 ], "default": 20, "minimum": 1, "maximum": 50 }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [ "query" ] }, "example": { "query": "lofi hip hop", "limit": 10 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "query": { "type": "string", "description": "Normalized search query" }, "type": { "type": "string", "description": "Applied type filter: all, video, shorts, channel or playlist" }, "sort": { "type": "string", "description": "Applied sort: relevance or popularity" }, "upload_date": { "type": [ "string", "null" ], "description": "Applied upload-date filter, null when not set" }, "results_fetched": { "type": "integer", "description": "Number of results returned" }, "has_more": { "type": "boolean", "description": "YouTube has more results beyond limit" }, "results": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "video, channel or playlist (Shorts are videos with is_short true)" }, "video_id": { "type": "string", "description": "Video items: 11-char video ID" }, "link": { "type": "string", "description": "Video items: watch URL (/shorts/ URL for Shorts)" }, "title": { "type": "string", "description": "Video, channel or playlist title" }, "channel": { "type": [ "object", "null" ], "properties": { "name": { "type": [ "string", "null" ], "description": "Channel name" }, "channel_id": { "type": [ "string", "null" ], "description": "Channel ID (UC...)" }, "handle": { "type": [ "string", "null" ], "description": "Channel handle including '@' when YouTube exposes it" }, "url": { "type": [ "string", "null" ], "description": "Channel URL" } }, "required": [], "description": "Video items: uploading channel (null for Shorts shelf items)" }, "view_count": { "type": [ "integer", "null" ], "description": "Video items: views (exact for regular results, rounded for Shorts shelf items; current viewers for live streams)" }, "view_count_text": { "type": [ "string", "null" ], "description": "Video items: raw text, e.g. '14,709,279 views' or '3,597 watching'" }, "published_text": { "type": [ "string", "null" ], "description": "Video items: relative time, e.g. '1 month ago'" }, "duration_text": { "type": [ "string", "null" ], "description": "Video items: duration, e.g. '6:10:58'" }, "duration_seconds": { "type": [ "integer", "null" ], "description": "Video items: duration in seconds" }, "thumbnail_url": { "type": [ "string", "null" ], "description": "Video and playlist items: largest thumbnail URL" }, "is_live": { "type": "boolean", "description": "Video items: live right now" }, "is_short": { "type": "boolean", "description": "Video items: YouTube Short" }, "channel_id": { "type": "string", "description": "Channel items: channel ID (UC...)" }, "handle": { "type": [ "string", "null" ], "description": "Channel items: handle including '@'" }, "description": { "type": [ "string", "null" ], "description": "Channel items: description snippet" }, "subscriber_count": { "type": [ "integer", "null" ], "description": "Channel items: approximate subscribers from rounded text" }, "subscriber_count_text": { "type": [ "string", "null" ], "description": "Channel items: raw text, e.g. '521M subscribers'" }, "is_verified": { "type": "boolean", "description": "Channel items: verified badge" }, "avatar_url": { "type": [ "string", "null" ], "description": "Channel items: largest avatar URL" }, "url": { "type": "string", "description": "Channel and playlist items: channel or playlist URL" }, "playlist_id": { "type": "string", "description": "Playlist items: playlist ID" }, "channel_name": { "type": [ "string", "null" ], "description": "Playlist items: owner shown by YouTube" }, "video_count": { "type": [ "integer", "null" ], "description": "Playlist items: number of videos (null for Mixes)" }, "video_count_text": { "type": [ "string", "null" ], "description": "Playlist items: raw text, e.g. '43 videos'" } }, "required": [ "type", "video_id", "link", "title", "is_live", "is_short", "channel_id", "is_verified", "url", "playlist_id" ] }, "description": "Results in YouTube's order, max limit. Fields depend on type" } }, "required": [ "query", "type", "sort", "results_fetched", "has_more", "results" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/youtube/comments": { "post": { "operationId": "youtube_comments", "summary": "YouTube comments", "description": "Top-level comments of a YouTube video by URL or ID, sorted by top or newest: text, author, likes, reply count, pinned and hearted flags, plus the total comment count.\n\n- Top-level comments only, about 20 per page; replies are not included. A pinned comment is listed first in both sorts.\n- Like counts are YouTube's rounded figures (for example 8.4K); comment_count is exact.\n- Returns 404 with code COMMENTS_DISABLED when comments are turned off, and NOT_FOUND when the video does not exist.\n\nCost: 1 credit per successful request.", "tags": [ "YouTube" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/youtube#youtube-comments" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string", "description": "YouTube video URL (watch, youtu.be, shorts, live or embed link; a bare ID also works).", "examples": [ "https://www.youtube.com/watch?v=dQw4w9WgXcQ" ] }, "id": { "type": "string", "description": "11-character video ID.", "examples": [ "dQw4w9WgXcQ" ] }, "sort": { "type": "string", "description": "top or newest. Default top.", "examples": [ "newest" ] }, "limit": { "type": "integer", "description": "Maximum number of comments to return.", "examples": [ 20 ], "default": 20, "minimum": 1, "maximum": 100 }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [], "anyOf": [ { "required": [ "url" ] }, { "required": [ "id" ] } ] }, "example": { "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ", "limit": 20 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "video_id": { "type": "string", "description": "11-char video ID" }, "sort": { "type": "string", "description": "Applied sort: top or newest" }, "comment_count": { "type": [ "integer", "null" ], "description": "Total comments on the video (exact)" }, "comments_fetched": { "type": "integer", "description": "Number of comments returned" }, "has_more": { "type": "boolean", "description": "More comments are available beyond limit" }, "comments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Comment ID" }, "link": { "type": "string", "description": "Permalink to the comment" }, "text": { "type": "string", "description": "Full comment text" }, "author": { "type": "object", "properties": { "name": { "type": [ "string", "null" ], "description": "Display name (usually the @handle)" }, "channel_id": { "type": [ "string", "null" ], "description": "Author channel ID (UC...)" }, "handle": { "type": [ "string", "null" ], "description": "Author handle including '@'" }, "avatar_url": { "type": [ "string", "null" ], "description": "Author avatar URL" }, "is_channel_owner": { "type": "boolean", "description": "Author is the video's channel" }, "is_verified": { "type": "boolean", "description": "Author has a verified badge" } }, "required": [ "is_channel_owner", "is_verified" ], "description": "Comment author" }, "like_count": { "type": [ "integer", "null" ], "description": "Likes, approximate from rounded text (0 when none)" }, "like_count_text": { "type": [ "string", "null" ], "description": "Raw text, e.g. '8.4K'; null when no likes" }, "reply_count": { "type": [ "integer", "null" ], "description": "Number of replies" }, "published_text": { "type": [ "string", "null" ], "description": "Relative time, e.g. '2 months ago' or '6 years ago (edited)'" }, "is_pinned": { "type": "boolean", "description": "Pinned by the channel" }, "is_hearted": { "type": "boolean", "description": "Hearted by the channel" } }, "required": [ "id", "link", "text", "author", "is_pinned", "is_hearted" ] }, "description": "Top-level comments, max limit" } }, "required": [ "video_id", "sort", "comments_fetched", "has_more", "comments" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/youtube/transcript": { "post": { "operationId": "youtube_transcript", "summary": "YouTube transcript", "description": "Transcript of a YouTube video from its captions: timed segments, joined plain text, chosen language and the list of available caption languages.\n\n- Without lang, the hand-written track in the video's spoken language is preferred, then YouTube's default track, then automatic captions.\n- lang matches the exact code first, then the same base language (pt matches pt-BR). Machine-translated transcripts are not offered.\n- Returns 404 with code NO_TRANSCRIPT when the video has no captions or none in the requested language (the message lists the available codes).\n\nCost: 1 credit per successful request.", "tags": [ "YouTube" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/youtube#youtube-transcript" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string", "description": "YouTube video URL (watch, youtu.be, shorts, live or embed link; a bare ID also works).", "examples": [ "https://www.youtube.com/watch?v=dQw4w9WgXcQ" ] }, "id": { "type": "string", "description": "11-character video ID.", "examples": [ "dQw4w9WgXcQ" ] }, "lang": { "type": "string", "description": "Caption language code such as en, de, pt-BR or es-419. Default: the video's original language.", "examples": [ "en" ] }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [], "anyOf": [ { "required": [ "url" ] }, { "required": [ "id" ] } ] }, "example": { "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "video_id": { "type": "string", "description": "11-char video ID" }, "language": { "type": "string", "description": "Language code of the returned track" }, "language_name": { "type": "string", "description": "Track name, e.g. 'English' or 'English (auto-generated)'" }, "is_auto_generated": { "type": "boolean", "description": "Track is YouTube's automatic captions" }, "available_languages": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Language code" }, "name": { "type": "string", "description": "Track name" }, "is_auto_generated": { "type": "boolean", "description": "Automatic captions" } }, "required": [ "code", "name", "is_auto_generated" ] }, "description": "All caption tracks of the video" }, "segment_count": { "type": "integer", "description": "Number of segments" }, "text": { "type": "string", "description": "All segments joined as plain text" }, "segments": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "number", "description": "Start time in seconds (2 decimals)" }, "duration": { "type": [ "number", "null" ], "description": "Duration in seconds (2 decimals)" }, "text": { "type": "string", "description": "Segment text" } }, "required": [ "start", "text" ] }, "description": "Timed caption segments" } }, "required": [ "video_id", "language", "language_name", "is_auto_generated", "available_languages", "segment_count", "text", "segments" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/youtube/playlist": { "post": { "operationId": "youtube_playlist", "summary": "YouTube playlist", "description": "A YouTube playlist by URL or ID: title, description, owner channel, video and view counts, plus its videos (max 100) with views, publish time and duration.\n\n- Returns the first page of the playlist (up to 100 videos). Unavailable videos are hidden by YouTube, so a page can hold fewer than 100.\n- Video view counts are YouTube's rounded figures (for example 4.4M); playlist view and video counts are exact.\n- Returns 404 when the playlist does not exist or is private.\n\nCost: 1 credit per successful request.", "tags": [ "YouTube" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/youtube#youtube-playlist" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string", "description": "Playlist URL or any YouTube link with a list= parameter (a bare playlist ID also works).", "examples": [ "https://www.youtube.com/playlist?list=PLOzDu-MXXLlj7croDcwz33c-a5rpNEBNe" ] }, "id": { "type": "string", "description": "Playlist ID (PL..., OLAK5uy_..., UU...).", "examples": [ "PLOzDu-MXXLlj7croDcwz33c-a5rpNEBNe" ] }, "limit": { "type": "integer", "description": "Maximum number of videos to return.", "examples": [ 10 ], "default": 50, "minimum": 1, "maximum": 100 }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [], "anyOf": [ { "required": [ "url" ] }, { "required": [ "id" ] } ] }, "example": { "url": "https://www.youtube.com/playlist?list=PLOzDu-MXXLlj7croDcwz33c-a5rpNEBNe", "limit": 10 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "playlist_id": { "type": "string", "description": "Playlist ID" }, "title": { "type": "string", "description": "Playlist title" }, "description": { "type": "string", "description": "Playlist description" }, "channel": { "type": [ "object", "null" ], "properties": { "name": { "type": [ "string", "null" ], "description": "Channel name" }, "channel_id": { "type": [ "string", "null" ], "description": "Channel ID (UC...)" }, "handle": { "type": [ "string", "null" ], "description": "Channel handle including '@' when YouTube exposes it" }, "url": { "type": [ "string", "null" ], "description": "Channel URL" } }, "required": [], "description": "Owner channel" }, "video_count": { "type": [ "integer", "null" ], "description": "Number of videos in the playlist" }, "video_count_text": { "type": [ "string", "null" ], "description": "Raw text, e.g. '43 videos'" }, "view_count": { "type": [ "integer", "null" ], "description": "Total playlist views" }, "view_count_text": { "type": [ "string", "null" ], "description": "Raw text, e.g. '306,365 views'" }, "thumbnail_url": { "type": [ "string", "null" ], "description": "Playlist thumbnail URL" }, "url": { "type": "string", "description": "Playlist URL" }, "videos_fetched": { "type": "integer", "description": "Number of videos returned" }, "has_more": { "type": "boolean", "description": "The playlist has more videos than returned" }, "videos": { "type": "array", "items": { "type": "object", "properties": { "video_id": { "type": "string", "description": "11-char video ID" }, "link": { "type": "string", "description": "Watch URL" }, "title": { "type": "string", "description": "Video title" }, "channel": { "type": [ "object", "null" ], "properties": { "name": { "type": [ "string", "null" ], "description": "Channel name" }, "channel_id": { "type": [ "string", "null" ], "description": "Channel ID (UC...)" }, "handle": { "type": [ "string", "null" ], "description": "Channel handle including '@' when YouTube exposes it" }, "url": { "type": [ "string", "null" ], "description": "Channel URL" } }, "required": [], "description": "Uploading channel" }, "view_count": { "type": [ "integer", "null" ], "description": "Approximate views from rounded text" }, "view_count_text": { "type": [ "string", "null" ], "description": "Raw text, e.g. '4.4M'" }, "published_text": { "type": [ "string", "null" ], "description": "Relative time, e.g. '4 years ago'" }, "duration_text": { "type": [ "string", "null" ], "description": "Duration badge, e.g. '2:03:14'" }, "duration_seconds": { "type": [ "integer", "null" ], "description": "Duration in seconds" }, "thumbnail_url": { "type": [ "string", "null" ], "description": "Largest thumbnail URL" }, "is_live": { "type": "boolean", "description": "Live right now" } }, "required": [ "video_id", "link", "title", "is_live" ] }, "description": "Videos in playlist order, max limit" } }, "required": [ "playlist_id", "title", "description", "url", "videos_fetched", "has_more", "videos" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/facebook/profile": { "post": { "operationId": "facebook_profile", "summary": "Facebook page", "description": "Public Facebook Page/profile metadata from Open Graph tags: name, bio, image and (for Pages) like/follower/talking-about counts.\n\n- Data comes from the public page preview. Counts are available for public Pages only.\n- Pages that do not exist or require login return 502 TARGET_BLOCKED instead of 404 and are not charged.\n\nCost: 1 credit per successful request.", "tags": [ "Facebook" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/facebook#facebook-profile" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "username": { "type": "string", "description": "Page/profile vanity name, numeric profile ID, or facebook.com URL.", "examples": [ "cristiano" ] }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [ "username" ] }, "example": { "username": "cristiano" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "username": { "type": "string", "description": "Echo of the requested vanity name or ID" }, "name": { "type": "string", "description": "Page/profile name (og:title)" }, "like_count": { "type": [ "integer", "null" ], "description": "Page likes" }, "follower_count": { "type": [ "integer", "null" ], "description": "Page followers" }, "talking_about_count": { "type": [ "integer", "null" ], "description": "People talking about this" }, "bio": { "type": "string", "description": "Description text; empty string if none" }, "profile_url": { "type": "string", "description": "Canonical URL (og:url) or constructed URL" }, "profile_image_url": { "type": [ "string", "null" ], "description": "Profile image URL (og:image)" } }, "required": [ "username", "name", "bio", "profile_url" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/telegram/profile": { "post": { "operationId": "telegram_profile", "summary": "Telegram profile", "description": "Telegram channel/group/bot/user card from t.me: name, type, verification, description, photo and subscriber/member/online counts.\n\n- Works for channels, groups, bots and users. type is inferred from the public counters.\n\nCost: 1 credit per successful request.", "tags": [ "Telegram" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/telegram#telegram-profile" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "username": { "type": "string", "description": "Telegram username, @handle or t.me link.", "examples": [ "durov" ] }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [ "username" ] }, "example": { "username": "durov" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "username": { "type": "string", "description": "Username as requested" }, "name": { "type": "string", "description": "Display name/title" }, "type": { "type": "string", "description": "'channel', 'group', 'bot' or 'user' (heuristic)" }, "is_verified": { "type": "boolean", "description": "Has verified badge" }, "description": { "type": "string", "description": "Bio/description; empty string if none" }, "photo_url": { "type": [ "string", "null" ], "description": "Profile photo URL" }, "subscriber_count": { "type": [ "integer", "null" ], "description": "Channel subscribers (exact)" }, "member_count": { "type": [ "integer", "null" ], "description": "Group members (exact)" }, "online_count": { "type": [ "integer", "null" ], "description": "Group members online now" }, "monthly_users": { "type": [ "integer", "null" ], "description": "Bot/mini-app monthly users" }, "extra_text": { "type": [ "string", "null" ], "description": "Raw counter line from the page" }, "link": { "type": "string", "description": "https://t.me/" }, "preview_url": { "type": [ "string", "null" ], "description": "t.me/s/ feed URL (channels only)" } }, "required": [ "username", "name", "type", "is_verified", "description", "link" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/telegram/posts": { "post": { "operationId": "telegram_posts", "summary": "Telegram channel posts", "description": "A public Telegram channel's header (counters, description) plus its latest messages (up to 100) with text, media, views and dates.\n\n- Public channels with web preview only.\n- Up to 100 latest messages. View counts are approximate; the original text is in view_count_text.\n\nCost: 2 credits per successful request.", "tags": [ "Telegram" ], "x-credits": 2, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/telegram#telegram-posts" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "username": { "type": "string", "description": "Public channel username, @handle or t.me link.", "examples": [ "durov" ] }, "limit": { "type": "integer", "description": "Maximum number of messages to return.", "examples": [ 25 ], "default": 20, "minimum": 1, "maximum": 100 }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [ "username" ] }, "example": { "username": "durov", "limit": 25 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "username": { "type": "string", "description": "Channel username from page header" }, "name": { "type": "string", "description": "Channel title" }, "is_verified": { "type": "boolean", "description": "Has verified badge" }, "description": { "type": "string", "description": "Channel description; empty string if none" }, "photo_url": { "type": [ "string", "null" ], "description": "Channel photo URL" }, "subscriber_count": { "type": [ "integer", "null" ], "description": "Approximate subscribers from compact text" }, "subscriber_count_text": { "type": [ "string", "null" ], "description": "Raw counter text, e.g. '11M'" }, "photo_count": { "type": [ "integer", "null" ], "description": "Approximate number of photos" }, "video_count": { "type": [ "integer", "null" ], "description": "Approximate number of videos" }, "file_count": { "type": [ "integer", "null" ], "description": "Approximate number of files" }, "link_count": { "type": [ "integer", "null" ], "description": "Approximate number of links" }, "link": { "type": "string", "description": "https://t.me/" }, "posts_fetched": { "type": "integer", "description": "Number of messages returned" }, "has_more": { "type": "boolean", "description": "Older messages exist beyond those returned" }, "posts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": [ "integer", "null" ], "description": "Message ID within the channel" }, "post": { "type": "string", "description": "'/' identifier" }, "link": { "type": "string", "description": "https://t.me//" }, "type": { "type": "string", "description": "text|photo|album|video|poll|document|voice|round_video|sticker" }, "text": { "type": "string", "description": "Plain-text message body" }, "photo_urls": { "type": "array", "items": { "type": "string" }, "description": "Photo URLs; empty if none" }, "video_url": { "type": [ "string", "null" ], "description": "Video file URL" }, "video_thumb_url": { "type": [ "string", "null" ], "description": "Video thumbnail URL" }, "video_duration": { "type": [ "string", "null" ], "description": "Duration text, e.g. '0:32'" }, "view_count": { "type": [ "integer", "null" ], "description": "Approximate views from compact text" }, "view_count_text": { "type": [ "string", "null" ], "description": "Raw views text, e.g. '3.76M'" }, "posted_at": { "type": [ "string", "null" ], "description": "Post time, ISO 8601 datetime" }, "is_forwarded": { "type": "boolean", "description": "Message was forwarded" }, "forwarded_from": { "type": [ "string", "null" ], "description": "Original source name if forwarded" }, "link_preview": { "type": [ "object", "null" ], "properties": { "url": { "type": "string", "description": "Previewed URL" }, "title": { "type": [ "string", "null" ], "description": "Preview title" }, "description": { "type": [ "string", "null" ], "description": "Preview description" } }, "required": [ "url" ], "description": "Link preview card" } }, "required": [ "post", "link", "type", "text", "photo_urls", "is_forwarded" ] }, "description": "Messages, newest first, max limit" } }, "required": [ "username", "name", "is_verified", "description", "link", "posts_fetched", "has_more", "posts" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/telegram/post": { "post": { "operationId": "telegram_post", "summary": "Telegram post", "description": "A single public Telegram channel message by link: text, media, views, date, forward info, link preview and channel info.\n\n- Pass url, post (\"channel/123\") or username together with id. Private channel links (t.me/c/...) are not supported.\n\nCost: 1 credit per successful request.", "tags": [ "Telegram" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/telegram#telegram-post" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string", "description": "Message link t.me//.", "examples": [ "https://t.me/durov/342" ] }, "post": { "type": "string", "description": "Alias of url, e.g. 'durov/342'.", "examples": [ "durov/342" ] }, "username": { "type": "string", "description": "Channel username; only together with id.", "examples": [ "durov" ] }, "id": { "type": "integer", "description": "Message ID; only together with username.", "examples": [ 342 ] }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [], "anyOf": [ { "required": [ "url" ] }, { "required": [ "post" ] }, { "required": [ "username", "id" ] } ] }, "example": { "url": "https://t.me/durov/342" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "channel": { "type": "object", "properties": { "username": { "type": "string", "description": "Channel username as requested" }, "name": { "type": [ "string", "null" ], "description": "Channel title" }, "photo_url": { "type": [ "string", "null" ], "description": "Channel photo URL" }, "link": { "type": "string", "description": "https://t.me/" } }, "required": [ "username", "link" ], "description": "Channel that posted the message" }, "id": { "type": [ "integer", "null" ], "description": "Message ID within the channel" }, "post": { "type": "string", "description": "'/' identifier" }, "link": { "type": "string", "description": "https://t.me//" }, "type": { "type": "string", "description": "text|photo|album|video|poll|document|voice|round_video|sticker" }, "text": { "type": "string", "description": "Plain-text message body" }, "photo_urls": { "type": "array", "items": { "type": "string" }, "description": "Photo URLs; empty if none" }, "video_url": { "type": [ "string", "null" ], "description": "Video file URL" }, "video_thumb_url": { "type": [ "string", "null" ], "description": "Video thumbnail URL" }, "video_duration": { "type": [ "string", "null" ], "description": "Duration text, e.g. '0:32'" }, "view_count": { "type": [ "integer", "null" ], "description": "Approximate views from compact text" }, "view_count_text": { "type": [ "string", "null" ], "description": "Raw views text, e.g. '3.76M'" }, "posted_at": { "type": [ "string", "null" ], "description": "Post time, ISO 8601 datetime" }, "is_forwarded": { "type": "boolean", "description": "Message was forwarded" }, "forwarded_from": { "type": [ "string", "null" ], "description": "Original source name if forwarded" }, "link_preview": { "type": [ "object", "null" ], "properties": { "url": { "type": "string", "description": "Previewed URL" }, "title": { "type": [ "string", "null" ], "description": "Preview title" }, "description": { "type": [ "string", "null" ], "description": "Preview description" } }, "required": [ "url" ], "description": "Link preview card" } }, "required": [ "channel", "post", "link", "type", "text", "photo_urls", "is_forwarded" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/spotify/track": { "post": { "operationId": "spotify_track", "summary": "Spotify track", "description": "A Spotify track by link/URI/ID: title, artists, duration, release date, explicit flag, cover image and 30-second preview URL.\n\n- Short links (spotify.link, spoti.fi) are not supported.\n\nCost: 1 credit per successful request.", "tags": [ "Spotify" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/spotify#spotify-track" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string", "description": "Track link, URI or ID.", "examples": [ "https://open.spotify.com/track/0V3wPSX9ygBnCm8psDIegu" ] }, "id": { "type": "string", "description": "22-character track ID.", "examples": [ "0V3wPSX9ygBnCm8psDIegu" ] }, "track": { "type": "string", "description": "Alias (link, URI or ID).", "examples": [ "spotify:track:0V3wPSX9ygBnCm8psDIegu" ] }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [], "anyOf": [ { "required": [ "url" ] }, { "required": [ "id" ] }, { "required": [ "track" ] } ] }, "example": { "url": "https://open.spotify.com/track/0V3wPSX9ygBnCm8psDIegu" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Spotify track ID" }, "link": { "type": "string", "description": "open.spotify.com track URL" }, "title": { "type": "string", "description": "Track title" }, "artists": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "description": "Spotify artist ID" }, "name": { "type": "string", "description": "Artist name" }, "link": { "type": [ "string", "null" ], "description": "open.spotify.com artist URL" } }, "required": [ "name" ] }, "description": "Credited artists" }, "duration_ms": { "type": [ "integer", "null" ], "description": "Track length in milliseconds" }, "release_date": { "type": [ "string", "null" ], "description": "Release date, ISO string" }, "is_explicit": { "type": "boolean", "description": "Marked explicit" }, "is_playable": { "type": "boolean", "description": "Playable in the embed" }, "has_video": { "type": "boolean", "description": "Track has a video" }, "preview_url": { "type": [ "string", "null" ], "description": "30-second MP3 preview URL" }, "image_url": { "type": [ "string", "null" ], "description": "Largest cover image URL" } }, "required": [ "id", "link", "title", "artists", "is_explicit", "is_playable", "has_video" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/spotify/artist": { "post": { "operationId": "spotify_artist", "summary": "Spotify artist", "description": "A Spotify artist by link/URI/ID: name, image and top tracks (~10) with durations and preview URLs.\n\n- Monthly listeners, followers and genres are not publicly available and are not returned.\n\nCost: 1 credit per successful request.", "tags": [ "Spotify" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/spotify#spotify-artist" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string", "description": "Artist link, URI or ID.", "examples": [ "https://open.spotify.com/artist/06HL4z0CvFAxyc27GXpf02" ] }, "id": { "type": "string", "description": "22-character artist ID.", "examples": [ "06HL4z0CvFAxyc27GXpf02" ] }, "artist": { "type": "string", "description": "Alias (link, URI or ID).", "examples": [ "spotify:artist:06HL4z0CvFAxyc27GXpf02" ] }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [], "anyOf": [ { "required": [ "url" ] }, { "required": [ "id" ] }, { "required": [ "artist" ] } ] }, "example": { "url": "https://open.spotify.com/artist/06HL4z0CvFAxyc27GXpf02" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Spotify artist ID" }, "link": { "type": "string", "description": "open.spotify.com artist URL" }, "name": { "type": "string", "description": "Artist name" }, "image_url": { "type": [ "string", "null" ], "description": "Largest artist image URL" }, "top_tracks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "description": "Spotify track ID" }, "title": { "type": "string", "description": "Track title" }, "artists_text": { "type": "string", "description": "Artist names as one string" }, "duration_ms": { "type": [ "integer", "null" ], "description": "Track length in milliseconds" }, "is_explicit": { "type": "boolean", "description": "Marked explicit" }, "preview_url": { "type": [ "string", "null" ], "description": "30-second MP3 preview URL" }, "link": { "type": [ "string", "null" ], "description": "open.spotify.com track URL" } }, "required": [ "title", "artists_text", "is_explicit" ] }, "description": "Artist's top tracks (~10)" }, "top_tracks_count": { "type": "integer", "description": "Number of top tracks returned" } }, "required": [ "id", "link", "name", "top_tracks", "top_tracks_count" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/spotify/album": { "post": { "operationId": "spotify_album", "summary": "Spotify album", "description": "A Spotify album by link/URI/ID: title, artists, release date, cover and the full track list.\n\nCost: 1 credit per successful request.", "tags": [ "Spotify" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/spotify#spotify-album" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string", "description": "Album link, URI or ID.", "examples": [ "https://open.spotify.com/album/151w1FgRZfnKZA9FEcg9Z3" ] }, "id": { "type": "string", "description": "22-character album ID.", "examples": [ "151w1FgRZfnKZA9FEcg9Z3" ] }, "album": { "type": "string", "description": "Alias (link, URI or ID).", "examples": [ "spotify:album:151w1FgRZfnKZA9FEcg9Z3" ] }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [], "anyOf": [ { "required": [ "url" ] }, { "required": [ "id" ] }, { "required": [ "album" ] } ] }, "example": { "id": "151w1FgRZfnKZA9FEcg9Z3" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Spotify album ID" }, "link": { "type": "string", "description": "open.spotify.com album URL" }, "title": { "type": "string", "description": "Album title" }, "artists_text": { "type": "string", "description": "Album artist names as one string" }, "release_date": { "type": [ "string", "null" ], "description": "Release date, ISO string" }, "is_explicit": { "type": "boolean", "description": "Marked explicit" }, "image_url": { "type": [ "string", "null" ], "description": "Largest cover image URL" }, "track_count": { "type": "integer", "description": "Number of tracks returned" }, "tracks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "description": "Spotify track ID" }, "title": { "type": "string", "description": "Track title" }, "artists_text": { "type": "string", "description": "Artist names as one string" }, "duration_ms": { "type": [ "integer", "null" ], "description": "Track length in milliseconds" }, "is_explicit": { "type": "boolean", "description": "Marked explicit" }, "preview_url": { "type": [ "string", "null" ], "description": "30-second MP3 preview URL" }, "link": { "type": [ "string", "null" ], "description": "open.spotify.com track URL" } }, "required": [ "title", "artists_text", "is_explicit" ] }, "description": "Album track list" } }, "required": [ "id", "link", "title", "artists_text", "is_explicit", "track_count", "tracks" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/spotify/playlist": { "post": { "operationId": "spotify_playlist", "summary": "Spotify playlist", "description": "A public Spotify playlist by link/URI/ID: title, owner, cover, total duration and up to ~50 tracks.\n\n- Public playlists only. Up to about 50 tracks are returned and track_count is the number of returned tracks.\n\nCost: 1 credit per successful request.", "tags": [ "Spotify" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/spotify#spotify-playlist" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string", "description": "Playlist link, URI or ID.", "examples": [ "https://open.spotify.com/playlist/37i9dQZF1DXcBWIGoYBM5M" ] }, "id": { "type": "string", "description": "22-character playlist ID.", "examples": [ "37i9dQZF1DXcBWIGoYBM5M" ] }, "playlist": { "type": "string", "description": "Alias (link, URI or ID).", "examples": [ "spotify:playlist:37i9dQZF1DXcBWIGoYBM5M" ] }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [], "anyOf": [ { "required": [ "url" ] }, { "required": [ "id" ] }, { "required": [ "playlist" ] } ] }, "example": { "url": "https://open.spotify.com/playlist/37i9dQZF1DXcBWIGoYBM5M" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Spotify playlist ID" }, "link": { "type": "string", "description": "open.spotify.com playlist URL" }, "title": { "type": "string", "description": "Playlist title" }, "owner": { "type": "string", "description": "Owner display name" }, "image_url": { "type": [ "string", "null" ], "description": "Largest cover image URL" }, "total_duration_ms": { "type": [ "integer", "null" ], "description": "Whole-playlist duration in milliseconds" }, "track_count": { "type": "integer", "description": "Tracks returned (max ~50), not total" }, "tracks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "description": "Spotify track ID" }, "title": { "type": "string", "description": "Track title" }, "artists_text": { "type": "string", "description": "Artist names as one string" }, "duration_ms": { "type": [ "integer", "null" ], "description": "Track length in milliseconds" }, "is_explicit": { "type": "boolean", "description": "Marked explicit" }, "preview_url": { "type": [ "string", "null" ], "description": "30-second MP3 preview URL" }, "link": { "type": [ "string", "null" ], "description": "open.spotify.com track URL" } }, "required": [ "title", "artists_text", "is_explicit" ] }, "description": "First ~50 playlist tracks" } }, "required": [ "id", "link", "title", "owner", "track_count", "tracks" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/pinterest/profile": { "post": { "operationId": "pinterest_profile", "summary": "Pinterest profile", "description": "Public Pinterest profile: name, about, website, verification and follower/following/pin/board/video-pin counts.\n\nCost: 1 credit per successful request.", "tags": [ "Pinterest" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/pinterest#pinterest-profile" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "username": { "type": "string", "description": "Pinterest username, @handle or profile URL.", "examples": [ "nasa" ] }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [ "username" ] }, "example": { "username": "nasa" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "user_id": { "type": [ "string", "null" ], "description": "Pinterest numeric user ID" }, "username": { "type": "string", "description": "Pinterest username" }, "full_name": { "type": "string", "description": "Display name" }, "about": { "type": "string", "description": "Profile bio text" }, "website_url": { "type": [ "string", "null" ], "description": "Profile website URL" }, "domain": { "type": [ "string", "null" ], "description": "Claimed/canonical website domain" }, "is_verified": { "type": "boolean", "description": "Verified identity or verified merchant" }, "follower_count": { "type": [ "integer", "null" ], "description": "Number of followers" }, "following_count": { "type": [ "integer", "null" ], "description": "Number of accounts followed" }, "pin_count": { "type": [ "integer", "null" ], "description": "Number of pins" }, "board_count": { "type": [ "integer", "null" ], "description": "Number of boards" }, "video_pin_count": { "type": [ "integer", "null" ], "description": "Number of video pins" }, "profile_image_url": { "type": [ "string", "null" ], "description": "Largest profile image URL" } }, "required": [ "username", "full_name", "about", "is_verified" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/pinterest/pins": { "post": { "operationId": "pinterest_pins", "summary": "Pinterest pins", "description": "A Pinterest profile plus its recent pins (up to 50) with images/videos, titles, descriptions, links and engagement counts.\n\n- Up to 50 recent pins. Grid results carry fewer counts than pinterest.pin.\n\nCost: 2 credits per successful request.", "tags": [ "Pinterest" ], "x-credits": 2, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/pinterest#pinterest-pins" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "username": { "type": "string", "description": "Pinterest username, @handle or profile URL.", "examples": [ "nasa" ] }, "limit": { "type": "integer", "description": "Maximum number of pins to return.", "examples": [ 12 ], "default": 12, "minimum": 1, "maximum": 50 }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [ "username" ] }, "example": { "username": "nasa", "limit": 12 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "user_id": { "type": [ "string", "null" ], "description": "Pinterest numeric user ID" }, "username": { "type": "string", "description": "Pinterest username" }, "full_name": { "type": "string", "description": "Display name" }, "about": { "type": "string", "description": "Profile bio text" }, "website_url": { "type": [ "string", "null" ], "description": "Profile website URL" }, "domain": { "type": [ "string", "null" ], "description": "Claimed/canonical website domain" }, "is_verified": { "type": "boolean", "description": "Verified identity or verified merchant" }, "follower_count": { "type": [ "integer", "null" ], "description": "Number of followers" }, "following_count": { "type": [ "integer", "null" ], "description": "Number of accounts followed" }, "pin_count": { "type": [ "integer", "null" ], "description": "Number of pins" }, "board_count": { "type": [ "integer", "null" ], "description": "Number of boards" }, "video_pin_count": { "type": [ "integer", "null" ], "description": "Number of video pins" }, "profile_image_url": { "type": [ "string", "null" ], "description": "Largest profile image URL" }, "pins": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Pin ID" }, "link": { "type": "string", "description": "https://www.pinterest.com/pin//" }, "title": { "type": "string", "description": "Pin title; empty string if none" }, "description": { "type": "string", "description": "Pin description; empty string if none" }, "alt_text": { "type": [ "string", "null" ], "description": "Alt text (auto or user-provided)" }, "dominant_color": { "type": [ "string", "null" ], "description": "Dominant color hex, e.g. '#0b0b09'" }, "image_url": { "type": [ "string", "null" ], "description": "Largest image URL (orig preferred)" }, "image_width": { "type": [ "integer", "null" ], "description": "Image width in pixels" }, "image_height": { "type": [ "integer", "null" ], "description": "Image height in pixels" }, "is_video": { "type": "boolean", "description": "Pin is a video" }, "video_url": { "type": [ "string", "null" ], "description": "Highest-resolution video URL" }, "video_duration_ms": { "type": [ "integer", "null" ], "description": "Video duration in milliseconds" }, "repin_count": { "type": [ "integer", "null" ], "description": "Number of saves/repins" }, "reaction_count": { "type": [ "integer", "null" ], "description": "Sum of all reactions" }, "comment_count": { "type": [ "integer", "null" ], "description": "Number of comments" }, "favorite_count": { "type": [ "integer", "null" ], "description": "Number of favorites (detail only)" }, "share_count": { "type": [ "integer", "null" ], "description": "Number of shares (detail only)" }, "outbound_link": { "type": [ "string", "null" ], "description": "Destination URL of the pin" }, "outbound_domain": { "type": [ "string", "null" ], "description": "Destination domain" }, "created_at": { "type": [ "string", "null" ], "description": "Creation date string as given by Pinterest" }, "board_name": { "type": [ "string", "null" ], "description": "Board containing the pin" }, "board_url": { "type": [ "string", "null" ], "description": "Board URL on pinterest.com" }, "pinner_username": { "type": [ "string", "null" ], "description": "Pinner's username" }, "pinner_full_name": { "type": [ "string", "null" ], "description": "Pinner's display name" }, "pinner_image_url": { "type": [ "string", "null" ], "description": "Pinner's avatar URL" } }, "required": [ "id", "link", "title", "description", "is_video" ] }, "description": "Recent pins, max limit" }, "pins_fetched": { "type": "integer", "description": "Number of pins returned" }, "has_more": { "type": "boolean", "description": "More pins exist beyond those returned" } }, "required": [ "username", "full_name", "about", "is_verified", "pins", "pins_fetched", "has_more" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/pinterest/pin": { "post": { "operationId": "pinterest_pin", "summary": "Pinterest pin", "description": "A single Pinterest pin by URL or ID: title, description, image/video, outbound link, engagement counts, board and pinner.\n\n- Send id as a string.\n\nCost: 1 credit per successful request.", "tags": [ "Pinterest" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/pinterest#pinterest-pin" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string", "description": "Pin URL or a pin.it short share link (a bare pin ID also works).", "examples": [ "https://www.pinterest.com/pin/142567144449027286/" ] }, "id": { "type": "string", "description": "Numeric pin ID; used only when url is empty.", "examples": [ "142567144449027286" ] }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [], "anyOf": [ { "required": [ "url" ] }, { "required": [ "id" ] } ] }, "example": { "url": "https://www.pinterest.com/pin/142567144449027286/" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Pin ID" }, "link": { "type": "string", "description": "https://www.pinterest.com/pin//" }, "title": { "type": "string", "description": "Pin title; empty string if none" }, "description": { "type": "string", "description": "Pin description; empty string if none" }, "alt_text": { "type": [ "string", "null" ], "description": "Alt text (auto or user-provided)" }, "dominant_color": { "type": [ "string", "null" ], "description": "Dominant color hex" }, "image_url": { "type": [ "string", "null" ], "description": "Largest image URL (orig preferred)" }, "image_width": { "type": [ "integer", "null" ], "description": "Image width in pixels" }, "image_height": { "type": [ "integer", "null" ], "description": "Image height in pixels" }, "is_video": { "type": "boolean", "description": "Pin is a video" }, "video_url": { "type": [ "string", "null" ], "description": "Highest-resolution video URL" }, "video_duration_ms": { "type": [ "integer", "null" ], "description": "Video duration in milliseconds" }, "repin_count": { "type": [ "integer", "null" ], "description": "Number of saves/repins" }, "reaction_count": { "type": [ "integer", "null" ], "description": "Sum of all reactions" }, "comment_count": { "type": [ "integer", "null" ], "description": "Number of comments" }, "favorite_count": { "type": [ "integer", "null" ], "description": "Number of favorites" }, "share_count": { "type": [ "integer", "null" ], "description": "Number of shares" }, "outbound_link": { "type": [ "string", "null" ], "description": "Destination URL of the pin" }, "outbound_domain": { "type": [ "string", "null" ], "description": "Destination domain" }, "created_at": { "type": [ "string", "null" ], "description": "Creation date string as given by Pinterest" }, "board_name": { "type": [ "string", "null" ], "description": "Board containing the pin" }, "board_url": { "type": [ "string", "null" ], "description": "Board URL on pinterest.com" }, "pinner_username": { "type": [ "string", "null" ], "description": "Pinner's username" }, "pinner_full_name": { "type": [ "string", "null" ], "description": "Pinner's display name" }, "pinner_image_url": { "type": [ "string", "null" ], "description": "Pinner's avatar URL" } }, "required": [ "id", "link", "title", "description", "is_video" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/pinterest/search": { "post": { "operationId": "pinterest_search", "summary": "Pinterest search", "description": "Search Pinterest pins by keyword: up to 50 results with images/videos, titles, descriptions, outbound links, board and pinner.\n\n- Up to 50 pins in Pinterest's logged-out relevance order. Promoted pins and board suggestions are skipped.\n- Search results carry fewer counts than pinterest.pin: repin, comment, favorite and share counts are usually null.\n\nCost: 2 credits per successful request.", "tags": [ "Pinterest" ], "x-credits": 2, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/pinterest#pinterest-search" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "query": { "type": "string", "description": "Search keywords (up to 200 characters).", "examples": [ "minimalist kitchen" ] }, "limit": { "type": "integer", "description": "Maximum number of pins to return.", "examples": [ 20 ], "default": 20, "minimum": 1, "maximum": 50 }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [ "query" ] }, "example": { "query": "minimalist kitchen", "limit": 20 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "query": { "type": "string", "description": "Search query as used (whitespace collapsed)" }, "pins": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Pin ID" }, "link": { "type": "string", "description": "https://www.pinterest.com/pin//" }, "title": { "type": "string", "description": "Pin title; empty string if none" }, "description": { "type": "string", "description": "Pin description; empty string if none" }, "alt_text": { "type": [ "string", "null" ], "description": "Alt text (auto or user-provided)" }, "dominant_color": { "type": [ "string", "null" ], "description": "Dominant color hex, e.g. '#0b0b09'" }, "image_url": { "type": [ "string", "null" ], "description": "Largest image URL (orig preferred)" }, "image_width": { "type": [ "integer", "null" ], "description": "Image width in pixels" }, "image_height": { "type": [ "integer", "null" ], "description": "Image height in pixels" }, "is_video": { "type": "boolean", "description": "Pin is a video" }, "video_url": { "type": [ "string", "null" ], "description": "Highest-resolution video URL" }, "video_duration_ms": { "type": [ "integer", "null" ], "description": "Video duration in milliseconds" }, "repin_count": { "type": [ "integer", "null" ], "description": "Number of saves/repins" }, "reaction_count": { "type": [ "integer", "null" ], "description": "Sum of all reactions" }, "comment_count": { "type": [ "integer", "null" ], "description": "Number of comments" }, "favorite_count": { "type": [ "integer", "null" ], "description": "Number of favorites (detail only)" }, "share_count": { "type": [ "integer", "null" ], "description": "Number of shares (detail only)" }, "outbound_link": { "type": [ "string", "null" ], "description": "Destination URL of the pin" }, "outbound_domain": { "type": [ "string", "null" ], "description": "Destination domain" }, "created_at": { "type": [ "string", "null" ], "description": "Creation date string as given by Pinterest" }, "board_name": { "type": [ "string", "null" ], "description": "Board containing the pin" }, "board_url": { "type": [ "string", "null" ], "description": "Board URL on pinterest.com" }, "pinner_username": { "type": [ "string", "null" ], "description": "Pinner's username" }, "pinner_full_name": { "type": [ "string", "null" ], "description": "Pinner's display name" }, "pinner_image_url": { "type": [ "string", "null" ], "description": "Pinner's avatar URL" } }, "required": [ "id", "link", "title", "description", "is_video" ] }, "description": "Matching pins in Pinterest's order, max limit" }, "pins_fetched": { "type": "integer", "description": "Number of pins returned" }, "has_more": { "type": "boolean", "description": "More results exist beyond those returned" } }, "required": [ "query", "pins", "pins_fetched", "has_more" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/pinterest/board": { "post": { "operationId": "pinterest_board", "summary": "Pinterest board", "description": "A public Pinterest board: name, description, pin/follower/section counts, owner and cover image, plus its first pins with images, links and engagement counts.\n\n- Logged-out Pinterest only serves the first 25 or so pins of a board, so fewer pins than limit can come back. has_more is true when the board has more pins.\n- Board pins have the same fields as pinterest.pins.\n\nCost: 2 credits per successful request.", "tags": [ "Pinterest" ], "x-credits": 2, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/pinterest#pinterest-board" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string", "description": "Board URL: https://www.pinterest.com///.", "examples": [ "https://www.pinterest.com/nasa/learn-with-nasa/" ] }, "username": { "type": "string", "description": "Board owner's username, @handle or profile URL; used with board when url is empty.", "examples": [ "nasa" ] }, "board": { "type": "string", "description": "Board slug as in the URL; a board name with spaces is converted to a slug.", "examples": [ "learn-with-nasa" ] }, "limit": { "type": "integer", "description": "Maximum number of pins to return (logged-out Pinterest serves at most about 25 pins of a board).", "examples": [ 20 ], "default": 20, "minimum": 1, "maximum": 25 }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [], "anyOf": [ { "required": [ "url" ] }, { "required": [ "username", "board" ] } ] }, "example": { "url": "https://www.pinterest.com/nasa/learn-with-nasa/", "limit": 20 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "board": { "type": "object", "properties": { "id": { "type": "string", "description": "Pinterest numeric board ID" }, "name": { "type": "string", "description": "Board name" }, "description": { "type": "string", "description": "Board description; empty string if none" }, "link": { "type": "string", "description": "https://www.pinterest.com///" }, "pin_count": { "type": [ "integer", "null" ], "description": "Number of pins on the board" }, "follower_count": { "type": [ "integer", "null" ], "description": "Number of board followers" }, "section_count": { "type": [ "integer", "null" ], "description": "Number of board sections" }, "cover_image_url": { "type": [ "string", "null" ], "description": "Board cover image URL" }, "owner": { "type": "object", "properties": { "username": { "type": "string", "description": "Owner's username" }, "full_name": { "type": "string", "description": "Owner's display name" }, "image_url": { "type": [ "string", "null" ], "description": "Owner's largest avatar URL" } }, "required": [ "username", "full_name" ], "description": "Board owner" } }, "required": [ "id", "name", "description", "link", "owner" ], "description": "Board details" }, "pins": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Pin ID" }, "link": { "type": "string", "description": "https://www.pinterest.com/pin//" }, "title": { "type": "string", "description": "Pin title; empty string if none" }, "description": { "type": "string", "description": "Pin description; empty string if none" }, "alt_text": { "type": [ "string", "null" ], "description": "Alt text (auto or user-provided)" }, "dominant_color": { "type": [ "string", "null" ], "description": "Dominant color hex, e.g. '#0b0b09'" }, "image_url": { "type": [ "string", "null" ], "description": "Largest image URL (orig preferred)" }, "image_width": { "type": [ "integer", "null" ], "description": "Image width in pixels" }, "image_height": { "type": [ "integer", "null" ], "description": "Image height in pixels" }, "is_video": { "type": "boolean", "description": "Pin is a video" }, "video_url": { "type": [ "string", "null" ], "description": "Highest-resolution video URL" }, "video_duration_ms": { "type": [ "integer", "null" ], "description": "Video duration in milliseconds" }, "repin_count": { "type": [ "integer", "null" ], "description": "Number of saves/repins" }, "reaction_count": { "type": [ "integer", "null" ], "description": "Sum of all reactions" }, "comment_count": { "type": [ "integer", "null" ], "description": "Number of comments" }, "favorite_count": { "type": [ "integer", "null" ], "description": "Number of favorites (detail only)" }, "share_count": { "type": [ "integer", "null" ], "description": "Number of shares (detail only)" }, "outbound_link": { "type": [ "string", "null" ], "description": "Destination URL of the pin" }, "outbound_domain": { "type": [ "string", "null" ], "description": "Destination domain" }, "created_at": { "type": [ "string", "null" ], "description": "Creation date string as given by Pinterest" }, "board_name": { "type": [ "string", "null" ], "description": "Board containing the pin" }, "board_url": { "type": [ "string", "null" ], "description": "Board URL on pinterest.com" }, "pinner_username": { "type": [ "string", "null" ], "description": "Pinner's username" }, "pinner_full_name": { "type": [ "string", "null" ], "description": "Pinner's display name" }, "pinner_image_url": { "type": [ "string", "null" ], "description": "Pinner's avatar URL" } }, "required": [ "id", "link", "title", "description", "is_video" ] }, "description": "Board pins in board order, max limit" }, "pins_fetched": { "type": "integer", "description": "Number of pins returned" }, "has_more": { "type": "boolean", "description": "The board has more pins than those returned" } }, "required": [ "board", "pins", "pins_fetched", "has_more" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/twitch/channel": { "post": { "operationId": "twitch_channel", "summary": "Twitch channel", "description": "Twitch channel info: display name, description, partner/affiliate status, followers, images and live-stream / last-broadcast details.\n\n- When the channel is live, is_live is true and stream holds the broadcast. Otherwise last_broadcast describes the previous one.\n\nCost: 1 credit per successful request.", "tags": [ "Twitch" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/twitch#twitch-channel" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "username": { "type": "string", "description": "Twitch login name or channel URL.", "examples": [ "shroud" ] }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [ "username" ] }, "example": { "username": "shroud" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "user_id": { "type": [ "string", "null" ], "description": "Twitch numeric user ID" }, "username": { "type": "string", "description": "Login name (lowercase)" }, "display_name": { "type": "string", "description": "Display name" }, "description": { "type": "string", "description": "Channel bio; empty string if none" }, "created_at": { "type": [ "string", "null" ], "description": "Account creation time, ISO 8601" }, "is_partner": { "type": "boolean", "description": "Twitch Partner" }, "is_affiliate": { "type": "boolean", "description": "Twitch Affiliate" }, "follower_count": { "type": [ "integer", "null" ], "description": "Number of followers" }, "profile_image_url": { "type": [ "string", "null" ], "description": "Profile image URL (300px)" }, "banner_image_url": { "type": [ "string", "null" ], "description": "Channel banner image URL" }, "is_live": { "type": "boolean", "description": "Channel is streaming right now" }, "stream": { "type": [ "object", "null" ], "properties": { "id": { "type": [ "string", "null" ], "description": "Stream ID" }, "title": { "type": "string", "description": "Stream title" }, "type": { "type": [ "string", "null" ], "description": "'live' or 'rerun'" }, "viewer_count": { "type": [ "integer", "null" ], "description": "Current viewers" }, "started_at": { "type": [ "string", "null" ], "description": "Stream start time, ISO 8601" }, "game": { "type": [ "string", "null" ], "description": "Category/game name" } }, "required": [ "title" ], "description": "Current stream; null when offline" }, "last_broadcast": { "type": [ "object", "null" ], "properties": { "started_at": { "type": [ "string", "null" ], "description": "Broadcast start time, ISO 8601" }, "title": { "type": "string", "description": "Broadcast title" }, "game": { "type": [ "string", "null" ], "description": "Category/game name" } }, "required": [ "title" ], "description": "Most recent broadcast info" } }, "required": [ "username", "display_name", "description", "is_partner", "is_affiliate", "is_live" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/twitch/videos": { "post": { "operationId": "twitch_videos", "summary": "Twitch videos", "description": "A Twitch channel's latest videos (past broadcasts, highlights or uploads, up to 50) with title, duration, view count, dates, thumbnail and game.\n\n- Newest first, up to 50 videos. Twitch refuses later pages to logged-out clients, so has_more only tells you that older videos exist.\n- type=all also includes premieres.\n\nCost: 1 credit per successful request.", "tags": [ "Twitch" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/twitch#twitch-videos" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "username": { "type": "string", "description": "Twitch login name or channel URL.", "examples": [ "shroud" ] }, "type": { "type": "string", "description": "Video type: archive (past broadcasts), highlight, upload or all.", "examples": [ "archive" ], "default": "archive" }, "limit": { "type": "integer", "description": "Maximum number of videos to return.", "examples": [ 20 ], "default": 20, "minimum": 1, "maximum": 50 }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [ "username" ] }, "example": { "username": "shroud", "type": "archive", "limit": 20 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "user_id": { "type": [ "string", "null" ], "description": "Twitch numeric user ID" }, "username": { "type": "string", "description": "Login name (lowercase)" }, "display_name": { "type": "string", "description": "Display name" }, "type": { "type": "string", "description": "Video type that was requested" }, "total_count": { "type": [ "integer", "null" ], "description": "Total videos of this type on the channel" }, "videos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Video ID" }, "link": { "type": "string", "description": "https://www.twitch.tv/videos/" }, "title": { "type": "string", "description": "Video title; empty string if none" }, "type": { "type": [ "string", "null" ], "description": "Lowercase broadcast type, e.g. 'archive', 'highlight', 'upload'" }, "duration_seconds": { "type": [ "integer", "null" ], "description": "Length in seconds" }, "view_count": { "type": [ "integer", "null" ], "description": "Number of views" }, "created_at": { "type": [ "string", "null" ], "description": "Creation time, ISO 8601" }, "published_at": { "type": [ "string", "null" ], "description": "Publish time, ISO 8601" }, "thumbnail_url": { "type": [ "string", "null" ], "description": "Preview thumbnail URL (640x360)" }, "game": { "type": [ "object", "null" ], "properties": { "id": { "type": [ "string", "null" ], "description": "Twitch game ID" }, "name": { "type": [ "string", "null" ], "description": "Game/category name" } }, "required": [], "description": "Game/category; null if none" } }, "required": [ "id", "link", "title" ] }, "description": "Videos, newest first, max limit" }, "videos_fetched": { "type": "integer", "description": "Number of videos returned" }, "has_more": { "type": "boolean", "description": "More videos exist beyond those returned" } }, "required": [ "username", "display_name", "type", "videos", "videos_fetched", "has_more" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } }, "/v1/twitch/clips": { "post": { "operationId": "twitch_clips", "summary": "Twitch clips", "description": "A Twitch channel's most viewed clips for a period (last day, week, month or all time, up to 50) with views, duration, creator, game and the source VOD timestamp.\n\n- Most viewed first within the period, up to 50 clips. Twitch refuses later pages to logged-out clients.\n- video_id, video_offset_seconds and vod_link are null when the source VOD has expired or was deleted.\n\nCost: 1 credit per successful request.", "tags": [ "Twitch" ], "x-credits": 1, "externalDocs": { "url": "https://scrapeeverything.com/docs/endpoints/twitch#twitch-clips" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "username": { "type": "string", "description": "Twitch login name or channel URL.", "examples": [ "shroud" ] }, "period": { "type": "string", "description": "Time window: last_day, last_week, last_month or all_time.", "examples": [ "last_week" ], "default": "last_week" }, "limit": { "type": "integer", "description": "Maximum number of clips to return.", "examples": [ 20 ], "default": 20, "minimum": 1, "maximum": 50 }, "cache_days": { "type": "integer", "minimum": 1, "maximum": 14, "description": "Accept a cached result up to this many days old (free when it hits)." } }, "required": [ "username" ] }, "example": { "username": "shroud", "period": "last_week", "limit": 20 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "user_id": { "type": [ "string", "null" ], "description": "Twitch numeric user ID" }, "username": { "type": "string", "description": "Login name (lowercase)" }, "display_name": { "type": "string", "description": "Display name" }, "period": { "type": "string", "description": "Period that was requested" }, "clips": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Clip ID" }, "slug": { "type": "string", "description": "Clip slug" }, "link": { "type": "string", "description": "https://www.twitch.tv//clip/" }, "title": { "type": "string", "description": "Clip title; empty string if none" }, "view_count": { "type": [ "integer", "null" ], "description": "Number of views" }, "duration_seconds": { "type": [ "integer", "null" ], "description": "Clip length in seconds" }, "created_at": { "type": [ "string", "null" ], "description": "Creation time, ISO 8601" }, "thumbnail_url": { "type": [ "string", "null" ], "description": "Thumbnail URL" }, "creator": { "type": [ "object", "null" ], "properties": { "username": { "type": [ "string", "null" ], "description": "Login name" }, "display_name": { "type": [ "string", "null" ], "description": "Display name" } }, "required": [], "description": "User who made the clip" }, "game": { "type": [ "object", "null" ], "properties": { "id": { "type": [ "string", "null" ], "description": "Twitch game ID" }, "name": { "type": [ "string", "null" ], "description": "Game/category name" } }, "required": [], "description": "Game/category; null if none" }, "video_id": { "type": [ "string", "null" ], "description": "Source VOD ID; null when the VOD is gone" }, "video_offset_seconds": { "type": [ "integer", "null" ], "description": "Clip start offset in the source VOD, in seconds" }, "vod_link": { "type": [ "string", "null" ], "description": "Source VOD URL at the clip's timestamp" } }, "required": [ "id", "slug", "link", "title" ] }, "description": "Clips, most viewed first, max limit" }, "clips_fetched": { "type": "integer", "description": "Number of clips returned" }, "has_more": { "type": "boolean", "description": "More clips exist in this period beyond those returned" } }, "required": [ "username", "display_name", "period", "clips", "clips_fetched", "has_more" ] }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/E400", "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged." }, "401": { "$ref": "#/components/responses/E401", "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged." }, "402": { "$ref": "#/components/responses/E402", "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged." }, "404": { "$ref": "#/components/responses/E404", "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed." }, "429": { "$ref": "#/components/responses/E429", "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset." }, "502": { "$ref": "#/components/responses/E502", "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically." }, "504": { "$ref": "#/components/responses/E504", "description": "Timed out (TIMEOUT). Refunded automatically." } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "Your API key from the dashboard. Server-side use only." } }, "schemas": { "Meta": { "type": "object", "properties": { "request_id": { "type": "string" }, "scraper": { "type": "string" }, "cached": { "type": "boolean" }, "cached_at": { "type": [ "string", "null" ], "format": "date-time" }, "cache_age_seconds": { "type": [ "integer", "null" ] }, "credits_charged": { "type": "integer" }, "credits_remaining": { "type": "integer" }, "duration_ms": { "type": "integer" } } }, "Error": { "type": "object", "required": [ "success", "message", "code" ], "properties": { "success": { "const": false }, "message": { "type": "string" }, "code": { "type": "string" }, "request_id": { "type": "string" }, "meta": { "type": "object", "properties": { "credits_charged": { "type": "integer" }, "credits_remaining": { "type": "integer" } } } } } }, "responses": { "E400": { "description": "Invalid parameters (VALIDATION_ERROR, INVALID_JSON). Not charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "E401": { "description": "Missing or invalid API key (AUTH_REQUIRED, INVALID_API_KEY). Not charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "E402": { "description": "Not enough credits (INSUFFICIENT_CREDITS). Not charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "E404": { "description": "Target not found, private or age-restricted (NOT_FOUND, PRIVATE_ACCOUNT, AGE_RESTRICTED). Billed: the lookup completed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "E429": { "description": "Rate or concurrency limit reached (RATE_LIMITED, CONCURRENCY_LIMIT). Not charged; see RateLimit-Reset.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "E502": { "description": "Blocked by the platform or proxy failure (TARGET_BLOCKED, PROXY_CONNECT_FAILED). Refunded automatically.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "E504": { "description": "Timed out (TIMEOUT). Refunded automatically.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }