{ "version": 1, "title": "jsonscraper first-party API request reference", "source_url": "https://jsonscraper.com/assets/data/product-api-reference.json", "notes": [ "Documented request names are taken from the official public Postman collections used to build the SDKs.", "Live response schemas are partial observations, not guarantees that every field or item will exist.", "No customer license keys, account quotas or raw profile text are included.", "A successful request does not establish analytical completeness or a platform-wide sample." ], "products": { "tiktok": { "base_url": "https://tiktok.evelode.com", "authentication": { "in": "query", "name": "license_key", "environment_variable": "JSONSCRAPER_TIKTOK_LICENSE_KEY" }, "documentation": "https://github.com/jsonscraper/tiktok-api-python/blob/main/docs/endpoints.md", "product_page": "https://jsonscraper.com/services/tiktok-scraper-api", "endpoints": [ { "product": "tiktok", "name": "get_no_watermark_url", "path": "/getNoWatermarkUrl", "method": "GET", "description": "Get non watermarked video url", "parameters": [ { "name": "video_url", "optional": false, "description": "TikTok video URL." }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_no_watermark_url_by_id", "path": "/getNoWatermarkUrlByID", "method": "GET", "description": "Get non watermarked video url by video ID", "parameters": [ { "name": "video_id", "optional": false, "description": "TikTok video ID." }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_video_by_id", "path": "/getVideoByID", "method": "GET", "description": "Get video info by ID", "parameters": [ { "name": "video_id", "optional": false, "description": "TikTok video ID." }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_video_by_url", "path": "/getVideoByUrl", "method": "GET", "description": "Get video info by URL", "parameters": [ { "name": "video_url", "optional": false, "description": "" }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_unshortened_url", "path": "/getUnshortenedUrl", "method": "GET", "description": "Convert short TikTok video URL to full TikTok video URL", "parameters": [ { "name": "video_url", "optional": false, "description": "Short TikTok video URL." }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_comments_by_url", "path": "/getCommentsByUrl", "method": "GET", "description": "Get comments list by video URL", "parameters": [ { "name": "video_url", "optional": false, "description": "TikTok video URL." }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "cursor", "optional": true, "description": "Used for scrolling (pagination) in comments items, you can get cursor value from the previous response." }, { "name": "count", "optional": true, "description": "Number of comments you want to get. For example: 30." }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_comments_by_id", "path": "/getCommentsByID", "method": "GET", "description": "Get comments list by video ID", "parameters": [ { "name": "video_id", "optional": false, "description": "TikTok video ID." }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "cursor", "optional": true, "description": "Used for scrolling (pagination) in comments items, you can get cursor value from the previous response." }, { "name": "count", "optional": true, "description": "Number of comments you want to get. For example: 30." }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_comments_replies", "path": "/getCommentsReplies", "method": "GET", "description": "Get comments replies", "parameters": [ { "name": "video_id", "optional": false, "description": "TikTok video ID." }, { "name": "comment_id", "optional": false, "description": "TikTok comment ID." }, { "name": "cursor", "optional": true, "description": "Used for scrolling (pagination) in comments items, you can get cursor value from the previous response." }, { "name": "count", "optional": true, "description": "Number of comments you want to get. For example: 30." }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "search_user", "path": "/searchUser", "method": "GET", "description": "Search for user by keyword", "parameters": [ { "name": "keyword", "optional": false, "description": "Any text or keyword" }, { "name": "cursor", "optional": true, "description": "Used for scrolling (pagination) in user items, you can get cursor value from the previous response." }, { "name": "count", "optional": true, "description": "Number of results you want to get. For example: 10." }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "follower_count", "optional": true, "description": "Filter by followers count, can be empty or one of: ZERO_TO_ONE_K (0 to 1k), ONE_K_TO_TEN_K (1k to 10k), TEN_K_TO_ONE_H_K(10k to 100k), ONE_H_K_PLUS(100k+)" }, { "name": "profile_type", "optional": true, "description": "Filter by user profile type, can be empty or one of: VERIFIED" }, { "name": "other_pref", "optional": true, "description": "Filter by other preference, can be empty or one of: USERNAME (keyword usage in username)." }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here.\n" } ] }, { "product": "tiktok", "name": "search_video", "path": "/searchVideo", "method": "GET", "description": "Search for video by keyword", "parameters": [ { "name": "keyword", "optional": false, "description": "Any text or keyword" }, { "name": "cursor", "optional": true, "description": "Used for scrolling (pagination) in video items, you can get cursor value from the previous response." }, { "name": "count", "optional": true, "description": "Number of results you want to get. For example: 10." }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." }, { "name": "date_posted", "optional": true, "description": "How long ago was the video posted. Valid values: 'yesterday', 'this-week', 'this-month', 'last-3-months', 'last-6-months' and 'all-time'." }, { "name": "sort_by", "optional": true, "description": "Sort videos by metrics. Valid values: 'most-liked', 'relevance' or 'date-posted'." }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" } ] }, { "product": "tiktok", "name": "search_music", "path": "/searchMusic", "method": "GET", "description": "Search for music by keyword", "parameters": [ { "name": "keyword", "optional": false, "description": "Any text or keyword" }, { "name": "cursor", "optional": true, "description": "Used for scrolling (pagination) in music items, you can get cursor value from the previous response." }, { "name": "count", "optional": true, "description": "Number of results you want to get. For example: 10." }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." }, { "name": "filter_by", "optional": true, "description": "Filter by type, can be empty or one of: 0 - All, 1 - Title, 2 - Creators" }, { "name": "sort_type", "optional": true, "description": "Sort type, can be empty or one of: 0 - Relevance, 1 - Most used, 2 - Most recent, 3 - Shortest, 4 - Longest" }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" } ] }, { "product": "tiktok", "name": "search_live", "path": "/searchLive", "method": "GET", "description": "Search for live by keyword", "parameters": [ { "name": "keyword", "optional": false, "description": "Any text or keyword" }, { "name": "offset", "optional": true, "description": "Used for scrolling (pagination) in live items, you can get offset value from the previous response." }, { "name": "count", "optional": true, "description": "Number of results you want to get. For example: 10." }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" } ] }, { "product": "tiktok", "name": "search_hashtag", "path": "/searchHashtag", "method": "GET", "description": "Search for hashtag by keyword", "parameters": [ { "name": "keyword", "optional": false, "description": "Any text or keyword" }, { "name": "cursor", "optional": true, "description": "Used for scrolling (pagination) in hashtag items, you can get cursor value from the previous response." }, { "name": "count", "optional": true, "description": "Number of results you want to get. For example: 10." }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "search_location", "path": "/searchLocation", "method": "GET", "description": "Search for location by keyword", "parameters": [ { "name": "keyword", "optional": false, "description": "" }, { "name": "cursor", "optional": true, "description": "Used for scrolling (pagination) in location items, you can get cursor value from the previous response." }, { "name": "count", "optional": true, "description": "Number of results you want to get. For example: 10." }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "search_top", "path": "/searchTop", "method": "GET", "description": "Top search by text query", "parameters": [ { "name": "keyword", "optional": false, "description": "Any text or keyword" }, { "name": "cursor", "optional": true, "description": "Used for scrolling (pagination) in video items, you can get cursor value from the previous response." }, { "name": "count", "optional": true, "description": "Number of results you want to get. For example: 10." }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "sort_type", "optional": true, "description": "Sort type, can be empty or one of: 1 - Most liked, 0 - Relevance" }, { "name": "publish_time", "optional": true, "description": "Date posted filter, can be empty or one of: 0 - All time, 1 - Yesterday, 7 - This week, 30 - This month, 90 - Last 3 months, 180 - Last 6 months" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "search_insights", "path": "/searchInsights", "method": "GET", "description": "Search insights by text query", "parameters": [ { "name": "keyword", "optional": false, "description": "Any text or keyword" }, { "name": "cursor", "optional": true, "description": "Used for scrolling (pagination) in video items, you can get cursor value from the previous response." }, { "name": "count", "optional": true, "description": "Number of results you want to get. For example: 25." }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "search_comment_suggested_users", "path": "/searchCommentSuggestedUsers", "method": "GET", "description": "Search comment suggested users", "parameters": [ { "name": "keyword", "optional": false, "description": "Any text or keyword" }, { "name": "count", "optional": true, "description": "Number of results you want to get. For example: 10." }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_user_info", "path": "/getUserInfo", "method": "GET", "description": "Get user info by profile URL or nickname", "parameters": [ { "name": "query", "optional": false, "description": "TikTok profile URL or nickname" }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_user_info_by_id", "path": "/getUserInfoByID", "method": "GET", "description": "Get user info by profile ID", "parameters": [ { "name": "user_id", "optional": false, "description": "TikTok User ID." }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_basic_user_info", "path": "/getBasicUserInfo", "method": "GET", "description": "Get user info by username", "parameters": [ { "name": "query", "optional": false, "description": "TikTok profile URL or nickname" }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_user_feed", "path": "/getUserFeed", "method": "GET", "description": "Get user feed by profile URL or nickname", "parameters": [ { "name": "query", "optional": false, "description": "TikTok profile URL or nickname" }, { "name": "max_cursor", "optional": true, "description": "Used for scrolling (pagination) in feed items, you can get max_cursor value from the previous response." }, { "name": "count", "optional": true, "description": "Number of items you want to get. For example: 10." }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "with_pinned_posts", "optional": true, "description": "Add pinned posts in response. Default: 1" }, { "name": "sort_type", "optional": true, "description": "Sort type for feed: 0 - Recent, 1 - Popular." }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_user_feed_by_id", "path": "/getUserFeedByID", "method": "GET", "description": "Get user feed by profile ID", "parameters": [ { "name": "user_id", "optional": false, "description": "TikTok User ID." }, { "name": "max_cursor", "optional": true, "description": "Used for scrolling (pagination) in feed items, you can get max_cursor value from the previous response." }, { "name": "count", "optional": true, "description": "Number of items you want to get. For example: 10." }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "with_pinned_posts", "optional": true, "description": "Add pinned posts in response. Default: 1" }, { "name": "sort_type", "optional": true, "description": "Sort type for feed: 0 - Recent, 1 - Popular." }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_user_id", "path": "/getUserID", "method": "GET", "description": "Get user ID by profile URL or nickname", "parameters": [ { "name": "query", "optional": false, "description": "TikTok profile URL or nickname" }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_username_by_id", "path": "/getUsernameByID", "method": "GET", "description": "Get username by TikTok user ID", "parameters": [ { "name": "user_id", "optional": false, "description": "TikTok User ID." }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_twitter_username", "path": "/getTwitterUsername", "method": "GET", "description": "Get Twitter username by profile URL, nickname or TikTok user ID", "parameters": [ { "name": "query", "optional": false, "description": "TikTok profile URL, nickname or TikTok user ID" }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_instagram_username", "path": "/getInstagramUsername", "method": "GET", "description": "Get Instagram username by profile URL, nickname or TikTok user ID", "parameters": [ { "name": "query", "optional": false, "description": "TikTok profile URL, nickname or TikTok user ID" }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_youtube_channel", "path": "/getYoutubeChannel", "method": "GET", "description": "Get YouTube channel info by profile URL, nickname or TikTok user ID", "parameters": [ { "name": "query", "optional": false, "description": "TikTok profile URL, nickname or TikTok user ID" }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_followers", "path": "/getFollowers", "method": "GET", "description": "Get user followers by profile URL or nickname", "parameters": [ { "name": "query", "optional": false, "description": "TikTok profile URL or nickname" }, { "name": "count", "optional": true, "description": "Number of items you want to get. For example: 20." }, { "name": "min_time", "optional": true, "description": "Used for scrolling (pagination) in followers array, you can get min_time value from the previous response." }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_followers_by_id", "path": "/getFollowersByID", "method": "GET", "description": "Get user followers by profile ID", "parameters": [ { "name": "user_id", "optional": false, "description": "TikTok User ID." }, { "name": "count", "optional": true, "description": "Number of items you want to get. For example: 20." }, { "name": "min_time", "optional": true, "description": "Used for scrolling (pagination) in followers array, you can get min_time value from the previous response." }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_following", "path": "/getFollowing", "method": "GET", "description": "Get user following by profile URL or nickname", "parameters": [ { "name": "query", "optional": false, "description": "TikTok profile URL or nickname" }, { "name": "count", "optional": true, "description": "Number of items you want to get. For example: 20." }, { "name": "min_time", "optional": true, "description": "Used for scrolling (pagination) in followings array, you can get min_time value from the previous response." }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_following_by_id", "path": "/getFollowingByID", "method": "GET", "description": "Get user following by profile ID", "parameters": [ { "name": "user_id", "optional": false, "description": "TikTok User ID." }, { "name": "count", "optional": true, "description": "Number of items you want to get. For example: 20." }, { "name": "min_time", "optional": true, "description": "Used for scrolling (pagination) in followings array, you can get min_time value from the previous response." }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_live_event_info_by_id", "path": "/getLiveEventInfoByID", "method": "GET", "description": "Get live event info by ID", "parameters": [ { "name": "event_id", "optional": false, "description": "Live event ID, can be obtained from user info in events array." }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_hashtag_info", "path": "/getHashtagInfo", "method": "GET", "description": "Get hashtag info by URL or tag name", "parameters": [ { "name": "query", "optional": false, "description": "TikTok hashtag URL or tag name" }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_hashtag_feed", "path": "/getHashtagFeed", "method": "GET", "description": "Get hashtag feed by URL or tag name", "parameters": [ { "name": "query", "optional": false, "description": "TikTok hashtag URL or tag name" }, { "name": "cursor", "optional": true, "description": "Used for scrolling (pagination) in hashtag items, you can get cursor value from the previous response." }, { "name": "count", "optional": true, "description": "Number of hashtag feed items you want to get. For example: 12." }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_hashtag_feed_by_id", "path": "/getHashtagFeedByID", "method": "GET", "description": "Get hashtag feed by ID", "parameters": [ { "name": "id", "optional": false, "description": "TikTok hashtag ID" }, { "name": "cursor", "optional": true, "description": "Used for scrolling (pagination) in hashtag items, you can get cursor value from the previous response." }, { "name": "count", "optional": true, "description": "Number of hashtag feed items you want to get. For example: 12." }, { "name": "region", "optional": true, "description": "Alpha-2 country code" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_location_info_by_id", "path": "/getLocationInfoByID", "method": "GET", "description": "Get location info by ID", "parameters": [ { "name": "location_id", "optional": false, "description": "" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_location_feed_by_id", "path": "/getLocationFeedByID", "method": "GET", "description": "Get videos by location ID", "parameters": [ { "name": "location_id", "optional": false, "description": "" }, { "name": "count", "optional": true, "description": "Number of location feed items you want to get. For example: 20." }, { "name": "cursor", "optional": true, "description": "Used for scrolling (pagination) in location items, you can get cursor value from the previous response." }, { "name": "region", "optional": true, "description": "Alpha-2 country code" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_music_info", "path": "/getMusicInfo", "method": "GET", "description": "Get music info by URL or ID", "parameters": [ { "name": "query", "optional": false, "description": "" }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_music_feed", "path": "/getMusicFeed", "method": "GET", "description": "Get music feed by URL or ID", "parameters": [ { "name": "query", "optional": false, "description": "" }, { "name": "cursor", "optional": true, "description": "" }, { "name": "count", "optional": true, "description": "" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" } ] }, { "product": "tiktok", "name": "get_music_charts", "path": "/getMusicCharts", "method": "GET", "description": "Get music charts", "parameters": [ { "name": "chart_type", "optional": true, "description": "Possible values: 0 - Top 50 (standard chart ranking), 1 - Viral 50 (tracks gaining rapid popularity); all available values can be retrieved from the music_chart_rank.chart_music_info field in the music detail response." }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" } ] }, { "product": "tiktok", "name": "get_trending_categories_list", "path": "/getTrendingCategoriesList", "method": "GET", "description": "Get trending categories list", "parameters": [ { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "offset", "optional": true, "description": "If in a response you get parameter hasMore equal to 1 then you also have cursor value for a next set of data." }, { "name": "count", "optional": true, "description": "Number of items to return. For example: 10." }, { "name": "cache_timeout", "optional": true, "description": "" } ] }, { "product": "tiktok", "name": "get_trending_feed", "path": "/getTrendingFeed", "method": "GET", "description": "Get trending feed", "parameters": [ { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "pull_type", "optional": true, "description": "The type of loading feed (0 - Initial loading, 2 - Load more, 8 - Reload)" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here.\n" } ] }, { "product": "tiktok", "name": "get_stickers_by_id", "path": "/getStickersByID", "method": "GET", "description": "Get effect information by IDs", "parameters": [ { "name": "sticker_ids", "optional": false, "description": "Comma separated ID's." }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_sticker_by_id", "path": "/getStickerByID", "method": "GET", "description": "Get effect information by ID", "parameters": [ { "name": "sticker_id", "optional": false, "description": "" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_sticker_feed_by_id", "path": "/getStickerFeedByID", "method": "GET", "description": "Get videos by effect ID", "parameters": [ { "name": "sticker_id", "optional": false, "description": "" }, { "name": "count", "optional": true, "description": "" }, { "name": "cursor", "optional": true, "description": "Used for scrolling (pagination) in location items, you can get cursor value from the previous response." }, { "name": "region", "optional": true, "description": "Alpha-2 country code" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_user_stories", "path": "/getUserStories", "method": "GET", "description": "Get user stories", "parameters": [ { "name": "user_id", "optional": false, "description": "TikTok User ID." }, { "name": "count", "optional": true, "description": "Number of items you want to get. For example: 5." }, { "name": "min_cursor", "optional": true, "description": "Used for scrolling (pagination) in stories items, you can get min_cursor value from the previous response." }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_story_info_by_id", "path": "/getStoryInfoByID", "method": "GET", "description": "Get story info by ID", "parameters": [ { "name": "story_id", "optional": false, "description": "TikTok Story ID." }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_user_playlists", "path": "/getUserPlaylists", "method": "GET", "description": "Get user playlists", "parameters": [ { "name": "user_id", "optional": false, "description": "TikTok User ID." }, { "name": "cursor", "optional": true, "description": "Used for scrolling (pagination) in stories items, you can get cursor value from the previous response." }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_user_playlist_by_id", "path": "/getUserPlaylistByID", "method": "GET", "description": "Get user playlist by ID", "parameters": [ { "name": "user_id", "optional": false, "description": "TikTok User ID." }, { "name": "playlist_id", "optional": false, "description": "TikTok Playlist ID (mix_id)." }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_video_by_playlist_id", "path": "/getVideoByPlaylistID", "method": "GET", "description": "Get video by playlist ID", "parameters": [ { "name": "user_id", "optional": false, "description": "TikTok User ID." }, { "name": "playlist_id", "optional": false, "description": "TikTok Playlist ID (mix_id)." }, { "name": "max_cursor", "optional": true, "description": "If in a response you get parameter has_more equal to 1 then you also have max_cursor value for a next set." }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_available_ranking_list", "path": "/getAvailableRankingList", "method": "GET", "description": "Get available ranking list", "parameters": [ { "name": "room_id", "optional": false, "description": "TikTok Live Room ID." }, { "name": "user_id", "optional": false, "description": "TikTok User ID." }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_ranking_info", "path": "/getRankingInfo", "method": "GET", "description": "Get ranking info", "parameters": [ { "name": "rank_type", "optional": false, "description": "Rank type can be obtained from /getAvailableRankingList response" }, { "name": "room_id", "optional": false, "description": "TikTok Live Room ID." }, { "name": "user_id", "optional": false, "description": "TikTok User ID." }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_live_info", "path": "/getLiveInfo", "method": "GET", "description": "Get live info", "parameters": [ { "name": "room_id", "optional": false, "description": "TikTok Live Room ID." }, { "name": "user_id", "optional": false, "description": "TikTok User ID." }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] }, { "product": "tiktok", "name": "get_live_feed", "path": "/getLiveFeed", "method": "GET", "description": "Get live feed", "parameters": [ { "name": "draw_room_id", "optional": false, "description": "The first livestream id (data[0].id_str) from initial live feed response." }, { "name": "max_time", "optional": true, "description": "Unix timestamp, use extra.max_time value from previous response." }, { "name": "region", "optional": true, "description": "Region (country) code. Default: US" }, { "name": "cache_timeout", "optional": true, "description": "Cache timeout in seconds. By default we use caching system with 3600 seconds window to speed up next requests to API. If you want to disable caching, you can set 0 here." } ] } ], "live_checks": [ { "path": "/getUserFeed", "parameters": { "query": "therock", "count": 3 }, "status": "ok", "observed_at": "2026-10-25T18:27:59.156918+00:00", "response_schema": { "status": "str", "tiktok": { "status_code": "int", "max_cursor": "int", "has_more": "int", "aweme_list": [ { "aweme_id": "str", "desc": "str", "create_time": "int", "author": { "uid": "str", "nickname": "str", "follower_count": "int", "unique_id": "str" }, "share_url": "str", "statistics": { "aweme_id": "str", "comment_count": "int", "digg_count": "int", "download_count": "int", "play_count": "int", "share_count": "int", "forward_count": "int", "lose_count": "int", "lose_comment_count": "int", "whatsapp_share_count": "int", "collect_count": "int", "repost_count": "int" } } ] } } }, { "path": "/getHashtagFeed", "parameters": { "query": "python", "count": 3 }, "status": "ok", "observed_at": "2026-10-25T18:27:59.894633+00:00", "response_schema": { "status": "str", "tiktok": { "cursor": "int", "has_more": "int", "status_code": "int", "aweme_list": [ { "author": { "follower_count": "int", "nickname": "str", "uid": "str", "unique_id": "str" }, "aweme_id": "str", "create_time": "int", "desc": "str", "share_url": "str", "statistics": { "aweme_id": "str", "collect_count": "int", "comment_count": "int", "digg_count": "int", "download_count": "int", "forward_count": "int", "lose_comment_count": "int", "lose_count": "int", "play_count": "int", "repost_count": "int", "share_count": "int", "whatsapp_share_count": "int" } } ] } } }, { "path": "/searchVideo", "parameters": { "keyword": "python tutorial", "count": 3 }, "status": "ok", "observed_at": "2026-10-25T18:28:06.087896+00:00", "response_schema": { "status": "str", "tiktok": { "cursor": "int", "has_more": "int", "status_code": "int", "aweme_list": [], "search_item_list": [ { "aweme_info": { "author": { "follower_count": "int", "nickname": "str", "uid": "str", "unique_id": "str" }, "aweme_id": "str", "create_time": "int", "desc": "str", "share_url": "str", "statistics": { "aweme_id": "str", "collect_count": "int", "comment_count": "int", "digg_count": "int", "download_count": "int", "forward_count": "int", "lose_comment_count": "int", "lose_count": "int", "play_count": "int", "repost_count": "int", "share_count": "int", "whatsapp_share_count": "int" } } } ] } } } ] }, "instagram": { "base_url": "https://ig.jsonscraper.com", "authentication": { "in": "query", "name": "license_key", "environment_variable": "JSONSCRAPER_INSTAGRAM_LICENSE_KEY" }, "documentation": "https://github.com/jsonscraper/instagram-api-python/blob/main/docs/endpoints.md", "product_page": "https://jsonscraper.com/services/ig-scraper-api", "endpoints": [ { "product": "instagram", "name": "v1_user_by_id", "path": "/v1/user/by/id", "method": "GET", "description": "Get user info by ID", "parameters": [ { "name": "id", "optional": false, "description": "" }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_user_by_username", "path": "/v1/user/by/username", "method": "GET", "description": "Get user info by username (by ID is faster)", "parameters": [ { "name": "username", "optional": false, "description": "" }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_user_by_url", "path": "/v1/user/by/url", "method": "GET", "description": "Get user info by URL (by ID is faster)", "parameters": [ { "name": "url", "optional": false, "description": "" }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_user_about", "path": "/v1/user/about", "method": "GET", "description": "Get info about user by ID", "parameters": [ { "name": "id", "optional": false, "description": "" }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_user_medias_chunk", "path": "/v1/user/medias/chunk", "method": "GET", "description": "Get posts (chunked)", "parameters": [ { "name": "user_id", "optional": false, "description": "" }, { "name": "end_cursor", "optional": true, "description": "String value. It is used for scrolling through the feed and load next media chunk. You can obtain this value from the response to the previous request." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_user_medias_pinned", "path": "/v1/user/medias/pinned", "method": "GET", "description": "Get pinned posts", "parameters": [ { "name": "user_id", "optional": false, "description": "" }, { "name": "amount", "optional": true, "description": "The number of publications you want to receive in response." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_user_clips_chunk", "path": "/v1/user/clips/chunk", "method": "GET", "description": "Get reels (chunked)", "parameters": [ { "name": "user_id", "optional": false, "description": "" }, { "name": "end_cursor", "optional": true, "description": "String value. It is used for scrolling through the feed and load next media chunk. You can obtain this value from the response to the previous request." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_user_tag_medias_chunk", "path": "/v1/user/tag/medias/chunk", "method": "GET", "description": "Get tagged (mentions) posts", "parameters": [ { "name": "user_id", "optional": false, "description": "" }, { "name": "max_id", "optional": true, "description": "String value. It is used for scrolling through the feed and load next media chunk." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_user_stories", "path": "/v1/user/stories", "method": "GET", "description": "Get user stories by ID", "parameters": [ { "name": "user_id", "optional": false, "description": "" }, { "name": "amount", "optional": true, "description": "The number of stories you want to receive in response." }, { "name": "force", "optional": true, "description": "Skip account privacy check" }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_user_stories_by_username", "path": "/v1/user/stories/by/username", "method": "GET", "description": "Get user stories by username (by ID is faster)", "parameters": [ { "name": "username", "optional": false, "description": "" }, { "name": "amount", "optional": true, "description": "The number of stories you want to receive in response." }, { "name": "force", "optional": true, "description": "Skip account privacy check" }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_user_highlights", "path": "/v1/user/highlights", "method": "GET", "description": "Get user highlights by ID", "parameters": [ { "name": "user_id", "optional": false, "description": "" }, { "name": "amount", "optional": true, "description": "The number of stories you want to receive in response." }, { "name": "force", "optional": true, "description": "Skip account privacy check" }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_user_highlights_by_username", "path": "/v1/user/highlights/by/username", "method": "GET", "description": "Get user highlights by username (by ID is faster)", "parameters": [ { "name": "username", "optional": false, "description": "" }, { "name": "amount", "optional": true, "description": "The number of stories you want to receive in response." }, { "name": "force", "optional": true, "description": "Skip account privacy check" }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_user_search_followers", "path": "/v1/user/search/followers", "method": "GET", "description": "Search in followers list by query (not working for legacy verified accounts)", "parameters": [ { "name": "user_id", "optional": false, "description": "Instagram ID of the user whose followers you want to check." }, { "name": "query", "optional": false, "description": "The keyword or nickname of the profile you want to find." }, { "name": "force", "optional": true, "description": "Skip account privacy check." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_user_search_following", "path": "/v1/user/search/following", "method": "GET", "description": "Search in followings list by query (not working for legacy verified accounts)", "parameters": [ { "name": "user_id", "optional": false, "description": "Instagram ID of the user whose following you want to check." }, { "name": "query", "optional": false, "description": "The keyword or nickname of the profile you want to find." }, { "name": "force", "optional": true, "description": "Skip account privacy check." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_user_following_chunk", "path": "/v1/user/following/chunk", "method": "GET", "description": "Get user following (chunked)", "parameters": [ { "name": "user_id", "optional": false, "description": "Instagram ID of the user whose following list you want to retrieve." }, { "name": "max_id", "optional": true, "description": "Pagination cursor. Use the max_id value from the previous response to load the next chunk of results." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_user_followers_chunk", "path": "/v1/user/followers/chunk", "method": "GET", "description": "Get user followers (chunked)", "parameters": [ { "name": "user_id", "optional": false, "description": "Instagram ID of the user whose followers list you want to retrieve." }, { "name": "max_id", "optional": true, "description": "Pagination cursor. Use the max_id value from the previous response to load the next chunk of results." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_media_by_id", "path": "/v1/media/by/id", "method": "GET", "description": "Get media info by ID", "parameters": [ { "name": "id", "optional": false, "description": "Unique ID of the media item." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_media_by_code", "path": "/v1/media/by/code", "method": "GET", "description": "Get media info by shortcode", "parameters": [ { "name": "code", "optional": false, "description": "Unique ID of the media item." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_media_by_url", "path": "/v1/media/by/url", "method": "GET", "description": "Get media info by URL", "parameters": [ { "name": "url", "optional": false, "description": "Unique ID of the media item." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_media_insight", "path": "/v1/media/insight", "method": "GET", "description": "Get media insights", "parameters": [ { "name": "media_id", "optional": false, "description": "Unique ID of the media item." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_media_comments_chunk", "path": "/v1/media/comments/chunk", "method": "GET", "description": "Get media comments (chunked)", "parameters": [ { "name": "id", "optional": false, "description": "Unique ID of the media item." }, { "name": "min_id", "optional": true, "description": "Pagination cursor (load older comments depending on IG behavior)." }, { "name": "max_id", "optional": true, "description": "Pagination cursor (load newer comments depending on IG behavior)." }, { "name": "can_support_threading", "optional": true, "description": "Enables threaded replies support when available." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_media_likers", "path": "/v1/media/likers", "method": "GET", "description": "Get media likers", "parameters": [ { "name": "id", "optional": false, "description": "Unique ID of the media item." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_media_user", "path": "/v1/media/user", "method": "GET", "description": "Get author of the media", "parameters": [ { "name": "media_id", "optional": false, "description": "Unique ID of the media item." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_media_oembed", "path": "/v1/media/oembed", "method": "GET", "description": "Get media oEmbed data", "parameters": [ { "name": "url", "optional": false, "description": "Full public Instagram media URL." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_media_code_from_pk", "path": "/v1/media/code/from/pk", "method": "GET", "description": "Get media code from media ID (PK) (unlimited usage)", "parameters": [ { "name": "pk", "optional": false, "description": "Unique ID of the media item." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_media_pk_from_code", "path": "/v1/media/pk/from/code", "method": "GET", "description": "Get media ID (PK) from shortcode (unlimited usage)", "parameters": [ { "name": "code", "optional": false, "description": "Media shortcode." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_media_pk_from_url", "path": "/v1/media/pk/from/url", "method": "GET", "description": "Get media ID (PK) from URL (unlimited usage)", "parameters": [ { "name": "url", "optional": false, "description": "Full public Instagram media URL." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_story_by_id", "path": "/v1/story/by/id", "method": "GET", "description": "Get story by ID", "parameters": [ { "name": "id", "optional": false, "description": "Story ID" }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_story_by_url", "path": "/v1/story/by/url", "method": "GET", "description": "Get story by URL", "parameters": [ { "name": "url", "optional": false, "description": "Full public story URL." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_story_download", "path": "/v1/story/download", "method": "GET", "description": "Download story by ID", "parameters": [ { "name": "id", "optional": false, "description": "Story ID." } ] }, { "product": "instagram", "name": "v1_story_download_by_url", "path": "/v1/story/download/by/url", "method": "GET", "description": "Download story by direct media URL (unlimited usage)", "parameters": [ { "name": "url", "optional": false, "description": "Direct media file URL (CDN link)." } ] }, { "product": "instagram", "name": "v1_story_download_by_story_url", "path": "/v1/story/download/by/story/url", "method": "GET", "description": "Download story file by story URL (IG story link)", "parameters": [ { "name": "url", "optional": false, "description": "Public IG story URL." } ] }, { "product": "instagram", "name": "v1_highlight_by_id", "path": "/v1/highlight/by/id", "method": "GET", "description": "Get highlight by ID", "parameters": [ { "name": "id", "optional": false, "description": "Highlight ID." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_highlight_by_url", "path": "/v1/highlight/by/url", "method": "GET", "description": "Get highlight by URL", "parameters": [ { "name": "url", "optional": false, "description": "Full highlight URL." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_location_by_id", "path": "/v1/location/by/id", "method": "GET", "description": "Get location by ID", "parameters": [ { "name": "id", "optional": false, "description": "Location ID." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_location_medias_top", "path": "/v1/location/medias/top", "method": "GET", "description": "Get location top medias", "parameters": [ { "name": "location_pk", "optional": false, "description": "Location ID (PK)" }, { "name": "amount", "optional": true, "description": "Number of items to return." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_location_medias_recent", "path": "/v1/location/medias/recent", "method": "GET", "description": "Get location recent medias", "parameters": [ { "name": "location_pk", "optional": false, "description": "Location ID (PK)" }, { "name": "amount", "optional": true, "description": "Number of items to return." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_location_medias_top_chunk", "path": "/v1/location/medias/top/chunk", "method": "GET", "description": "Get location top medias (chunked)", "parameters": [ { "name": "location_pk", "optional": false, "description": "Location ID (PK)" }, { "name": "max_id", "optional": true, "description": "String value. It is used for scrolling through the feed and load next media chunk. You can obtain this value from the response to the previous request." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_location_medias_recent_chunk", "path": "/v1/location/medias/recent/chunk", "method": "GET", "description": "Get location recent medias (chunked)", "parameters": [ { "name": "location_pk", "optional": false, "description": "Location ID (PK)" }, { "name": "max_id", "optional": true, "description": "String value. It is used for scrolling through the feed and load next media chunk. You can obtain this value from the response to the previous request." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_location_search", "path": "/v1/location/search", "method": "GET", "description": "Search locations", "parameters": [ { "name": "lat", "optional": false, "description": "Latitude" }, { "name": "lng", "optional": false, "description": "Longitude" }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_hashtag_by_name", "path": "/v1/hashtag/by/name", "method": "GET", "description": "Get hashtag by name", "parameters": [ { "name": "name", "optional": false, "description": "Hashtag name (without # and special symbols)." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_hashtag_medias_top", "path": "/v1/hashtag/medias/top", "method": "GET", "description": "Get hashtag top medias", "parameters": [ { "name": "name", "optional": false, "description": "Hashtag name (without # and special symbols)." }, { "name": "amount", "optional": true, "description": "Number of items to return." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_hashtag_medias_top_chunk", "path": "/v1/hashtag/medias/top/chunk", "method": "GET", "description": "Get hashtag top medias (chunked)", "parameters": [ { "name": "name", "optional": false, "description": "Hashtag name (without # and special symbols)." }, { "name": "max_id", "optional": true, "description": "Pagination cursor for the next chunk. You can obtain this value from the response to the previous request." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_hashtag_medias_top_recent_chunk", "path": "/v1/hashtag/medias/top/recent/chunk", "method": "GET", "description": "Get hashtag recent medias (chunked)", "parameters": [ { "name": "name", "optional": false, "description": "Hashtag name (without # and special symbols)." }, { "name": "max_id", "optional": true, "description": "Pagination cursor for the next chunk. You can obtain this value from the response to the previous request." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_hashtag_medias_clips_chunk", "path": "/v1/hashtag/medias/clips/chunk", "method": "GET", "description": "Get hashtag clips (chunked)", "parameters": [ { "name": "name", "optional": false, "description": "Hashtag name (without # and special symbols)." }, { "name": "max_id", "optional": true, "description": "Pagination cursor for the next chunk. You can obtain this value from the response to the previous request." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_search_hashtags", "path": "/v1/search/hashtags", "method": "GET", "description": "Search hashtags", "parameters": [ { "name": "query", "optional": false, "description": "Search query text." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_search_users", "path": "/v1/search/users", "method": "GET", "description": "Search users", "parameters": [ { "name": "query", "optional": false, "description": "Search query text." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_search_music", "path": "/v1/search/music", "method": "GET", "description": "Search music", "parameters": [ { "name": "query", "optional": false, "description": "Search query text." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_fbsearch_places", "path": "/v1/fbsearch/places", "method": "GET", "description": "Search places", "parameters": [ { "name": "query", "optional": false, "description": "Search query text." }, { "name": "lat", "optional": true, "description": "Latitude." }, { "name": "lng", "optional": true, "description": "Longitude." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v1_fbsearch_topsearch", "path": "/v1/fbsearch/topsearch", "method": "GET", "description": "Top search", "parameters": [ { "name": "query", "optional": false, "description": "Search query text." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_user_by_id", "path": "/v2/user/by/id", "method": "GET", "description": "Get user info by ID", "parameters": [ { "name": "id", "optional": false, "description": "Numeric Instagram user ID." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_user_by_username", "path": "/v2/user/by/username", "method": "GET", "description": "Get user info by username", "parameters": [ { "name": "username", "optional": false, "description": "Instagram username (without @)." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_userstream_by_id", "path": "/v2/userstream/by/id", "method": "GET", "description": "Get user info stream by ID", "parameters": [ { "name": "id", "optional": false, "description": "Numeric Instagram user ID." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_userstream_by_username", "path": "/v2/userstream/by/username", "method": "GET", "description": "Get user info stream by username", "parameters": [ { "name": "username", "optional": false, "description": "Instagram username (without @)." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_user_stories", "path": "/v2/user/stories", "method": "GET", "description": "Get user stories by ID", "parameters": [ { "name": "user_id", "optional": false, "description": "Numeric Instagram user ID." }, { "name": "force", "optional": true, "description": "Skip account privacy checks." }, { "name": "safe_int", "optional": true, "description": "Convert large integers to strings." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_user_stories_by_username", "path": "/v2/user/stories/by/username", "method": "GET", "description": "Get user stories by username", "parameters": [ { "name": "username", "optional": false, "description": "Instagram username (without @)." }, { "name": "force", "optional": true, "description": "Skip account privacy checks." }, { "name": "safe_int", "optional": true, "description": "Convert large integers to strings." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_user_clips", "path": "/v2/user/clips", "method": "GET", "description": "Get user reels by ID", "parameters": [ { "name": "user_id", "optional": false, "description": "Numeric Instagram user ID." }, { "name": "page_id", "optional": true, "description": "Pagination cursor (use next_page_id from previous response)." }, { "name": "safe_int", "optional": true, "description": "Convert large integers to strings." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_user_following", "path": "/v2/user/following", "method": "GET", "description": "Get user following list", "parameters": [ { "name": "user_id", "optional": false, "description": "Numeric Instagram user ID." }, { "name": "page_id", "optional": true, "description": "Pagination cursor (use next_page_id from previous response)." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_user_followers", "path": "/v2/user/followers", "method": "GET", "description": "Get user followers list", "parameters": [ { "name": "user_id", "optional": false, "description": "Numeric Instagram user ID." }, { "name": "page_id", "optional": true, "description": "Pagination cursor (use next_page_id from previous response)." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_user_tag_medias", "path": "/v2/user/tag/medias", "method": "GET", "description": "Get media where user is tagged", "parameters": [ { "name": "user_id", "optional": false, "description": "Numeric Instagram user ID." }, { "name": "page_id", "optional": true, "description": "Pagination cursor (use next_page_id from previous response)." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_user_highlights", "path": "/v2/user/highlights", "method": "GET", "description": "Get user highlights by ID", "parameters": [ { "name": "user_id", "optional": false, "description": "Numeric Instagram user ID." }, { "name": "amount", "optional": true, "description": "The number of stories you want to receive in response." }, { "name": "force", "optional": true, "description": "Skip account privacy check" }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_user_highlights_by_username", "path": "/v2/user/highlights/by/username", "method": "GET", "description": "Get user highlights by username (by ID is faster)", "parameters": [ { "name": "username", "optional": false, "description": "" }, { "name": "amount", "optional": true, "description": "The number of stories you want to receive in response." }, { "name": "force", "optional": true, "description": "Skip account privacy check" }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_user_explore_businesses_by_id", "path": "/v2/user/explore/businesses/by/id", "method": "GET", "description": "Get business suggestions for user", "parameters": [ { "name": "user_id", "optional": false, "description": "Numeric Instagram user ID." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_user_suggested_profiles", "path": "/v2/user/suggested/profiles", "method": "GET", "description": "Get suggested profiles for user", "parameters": [ { "name": "user_id", "optional": false, "description": "Numeric Instagram user ID." }, { "name": "expand_suggestion", "optional": true, "description": "Expand suggestion object with more details." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_media_info_by_id", "path": "/v2/media/info/by/id", "method": "GET", "description": "Get media info by ID", "parameters": [ { "name": "id", "optional": false, "description": "Unique ID of the media item." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_media_info_by_code", "path": "/v2/media/info/by/code", "method": "GET", "description": "Get media info by shortcode", "parameters": [ { "name": "code", "optional": false, "description": "Unique ID of the media item." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_media_info_by_url", "path": "/v2/media/info/by/url", "method": "GET", "description": "Get media info by URL", "parameters": [ { "name": "url", "optional": false, "description": "Unique ID of the media item." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_media_comments", "path": "/v2/media/comments", "method": "GET", "description": "Get media comments", "parameters": [ { "name": "id", "optional": false, "description": "Unique ID of the media item." }, { "name": "page_id", "optional": true, "description": "Pagination cursor (use next_page_id from previous response)." }, { "name": "can_support_threading", "optional": true, "description": "Enables threaded replies support when available." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_media_likers", "path": "/v2/media/likers", "method": "GET", "description": "Get media likers", "parameters": [ { "name": "id", "optional": false, "description": "Unique ID of the media item." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_media_comment_offensive", "path": "/v2/media/comment/offensive", "method": "GET", "description": "Check comment for offensiveness", "parameters": [ { "name": "media_id", "optional": false, "description": "Unique ID of the media item." }, { "name": "comment", "optional": false, "description": "Comment text to evaluate." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_media_comments_replies", "path": "/v2/media/comments/replies", "method": "GET", "description": "Get comment replies", "parameters": [ { "name": "media_id", "optional": false, "description": "Unique ID of the media item." }, { "name": "comment_id", "optional": false, "description": "Comment ID to load replies for." }, { "name": "min_id", "optional": true, "description": "Pagination cursor. Use next_min_id from the previous response." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_story_by_id", "path": "/v2/story/by/id", "method": "GET", "description": "Get story by ID", "parameters": [ { "name": "id", "optional": false, "description": "Story ID" }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_track_by_canonical_id", "path": "/v2/track/by/canonical/id", "method": "GET", "description": "Get music feed by canonical ID", "parameters": [ { "name": "canonical_id", "optional": false, "description": "Canonical music ID." }, { "name": "page_id", "optional": true, "description": "Pagination cursor (next_page_id from previous response)." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_track_by_id", "path": "/v2/track/by/id", "method": "GET", "description": "Get music feed by ID", "parameters": [ { "name": "track_id", "optional": false, "description": "Instagram track ID." }, { "name": "page_id", "optional": true, "description": "Pagination cursor (next_page_id from previous response)." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_hashtag_by_name", "path": "/v2/hashtag/by/name", "method": "GET", "description": "Get hashtag by name", "parameters": [ { "name": "name", "optional": false, "description": "Hashtag name (without # and special symbols)." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_hashtag_medias_top", "path": "/v2/hashtag/medias/top", "method": "GET", "description": "Get hashtag top medias", "parameters": [ { "name": "name", "optional": false, "description": "Hashtag name (without # and special symbols)." }, { "name": "page_id", "optional": true, "description": "Pagination cursor (next_page_id from previous response)" }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_hashtag_medias_recent", "path": "/v2/hashtag/medias/recent", "method": "GET", "description": "Get hashtag recent medias", "parameters": [ { "name": "name", "optional": false, "description": "Hashtag name (without # and special symbols)." }, { "name": "page_id", "optional": true, "description": "Pagination cursor (next_page_id from previous response)" }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_highlight_by_id", "path": "/v2/highlight/by/id", "method": "GET", "description": "Get highlight by ID", "parameters": [ { "name": "id", "optional": false, "description": "Highlight ID." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_search_hashtags", "path": "/v2/search/hashtags", "method": "GET", "description": "Search hashtags", "parameters": [ { "name": "query", "optional": false, "description": "Search query text." }, { "name": "page_token", "optional": true, "description": "Pagination token. Use the next_page_token from the previous response." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_search_music", "path": "/v2/search/music", "method": "GET", "description": "Search music", "parameters": [ { "name": "query", "optional": false, "description": "Search query text." }, { "name": "next_max_id", "optional": true, "description": "Cursor for the next page. Use the next_max_id value from the previous response." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_fbsearch_accounts", "path": "/v2/fbsearch/accounts", "method": "GET", "description": "Search accounts (users)", "parameters": [ { "name": "query", "optional": false, "description": "Search query text." }, { "name": "page_token", "optional": true, "description": "Pagination token from the previous response." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_fbsearch_places", "path": "/v2/fbsearch/places", "method": "GET", "description": "Search places (locations)", "parameters": [ { "name": "query", "optional": false, "description": "Search keyword (username or name)." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_fbsearch_topsearch", "path": "/v2/fbsearch/topsearch", "method": "GET", "description": "Top search", "parameters": [ { "name": "query", "optional": false, "description": "Search query text." }, { "name": "next_max_id", "optional": true, "description": "Use the next_max_id value from the previous response." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v2_fbsearch_reels", "path": "/v2/fbsearch/reels", "method": "GET", "description": "Search reels (clips)", "parameters": [ { "name": "query", "optional": false, "description": "Search keyword." }, { "name": "reels_max_id", "optional": true, "description": "Cursor for the next page. Use the reels_max_id value from the previous response." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "gql_comments_chunk", "path": "/gql/comments/chunk", "method": "GET", "description": "Get comments list by media ID (chunked)", "parameters": [ { "name": "media_id", "optional": false, "description": "IG media ID." }, { "name": "sort_order", "optional": true, "description": "Sorting mode. Allowed: recent, popular" }, { "name": "end_cursor", "optional": true, "description": "Cursor for the next page. Use the end_cursor value from the previous response." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "gql_comments_threaded_chunk", "path": "/gql/comments/threaded/chunk", "method": "GET", "description": "Get threaded replies list by comment ID (chunked)", "parameters": [ { "name": "media_id", "optional": false, "description": "IG media ID." }, { "name": "comment_id", "optional": false, "description": "Parent comment ID to load replies for." }, { "name": "end_cursor", "optional": true, "description": "Cursor for the next page. Use the end_cursor value from the previous response." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "gql_comment_likers_chunk", "path": "/gql/comment/likers/chunk", "method": "GET", "description": "Get comment likers list by comment ID (chunked)", "parameters": [ { "name": "comment_id", "optional": false, "description": "Comment ID." }, { "name": "end_cursor", "optional": true, "description": "Cursor for the next page. Use the end_cursor value from the previous response." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "gql_topsearch", "path": "/gql/topsearch", "method": "GET", "description": "Search top content by keyword", "parameters": [ { "name": "query", "optional": false, "description": "Search keyword/query." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "gql_media_likers", "path": "/gql/media/likers", "method": "GET", "description": "Get media likers by media ID", "parameters": [ { "name": "media_id", "optional": false, "description": "IG media ID." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "gql_media_usertags", "path": "/gql/media/usertags", "method": "GET", "description": "Get video usertags by media IDs", "parameters": [ { "name": "media_ids", "optional": false, "description": "One or multiple comma-separated media IDs (up to 10)." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "gql_user_followers_chunk", "path": "/gql/user/followers/chunk", "method": "GET", "description": "Get user followers (chunked)", "parameters": [ { "name": "user_id", "optional": false, "description": "Target user ID." }, { "name": "force", "optional": true, "description": "Skip account privacy validation check (if applicable in your implementation)." }, { "name": "end_cursor", "optional": true, "description": "Cursor for the next page. Use the end_cursor value from the previous response." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "gql_user_following_chunk", "path": "/gql/user/following/chunk", "method": "GET", "description": "Get user following (chunked)", "parameters": [ { "name": "user_id", "optional": false, "description": "Target user ID." }, { "name": "force", "optional": true, "description": "Skip account privacy validation check (if applicable in your implementation)." }, { "name": "end_cursor", "optional": true, "description": "Cursor for the next page. Use the end_cursor value from the previous response." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "gql_user_reposts", "path": "/gql/user/reposts", "method": "GET", "description": "Get user reposts", "parameters": [ { "name": "user_id", "optional": false, "description": "Target user ID." }, { "name": "repost_next_max_id", "optional": true, "description": "Cursor for the next page. Use the repost_next_max_id value from the previous response." }, { "name": "flat", "optional": true, "description": "If true, returns results in a flattened list format instead of nested structures." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "gql_user_clips", "path": "/gql/user/clips", "method": "GET", "description": "Get user clips (reels)", "parameters": [ { "name": "user_id", "optional": false, "description": "Target user ID." }, { "name": "max_id", "optional": true, "description": "Cursor for the next page. Use the max_id value from the previous response." }, { "name": "sort_by_views", "optional": true, "description": "If true, clips will be sorted by view count (typically descending)." }, { "name": "flat", "optional": true, "description": "If true, returns clips in a flattened list format." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "gql_user_medias", "path": "/gql/user/medias", "method": "GET", "description": "Get user profile media (grid)", "parameters": [ { "name": "user_id", "optional": false, "description": "Target user ID." }, { "name": "profile_grid_items_cursor", "optional": true, "description": "Cursor for the next page. Use the profile_grid_items_cursor value from the previous response." }, { "name": "flat", "optional": true, "description": "If true, returns clips in a flattened list format." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v3_fbsearch_accounts", "path": "/v3/fbsearch/accounts", "method": "GET", "description": "Search users", "parameters": [ { "name": "query", "optional": false, "description": "Search keyword (username or name)." }, { "name": "page_token", "optional": true, "description": "Pagination token. Use the next_page_token value from the previous response to retrieve the next page." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] }, { "product": "instagram", "name": "v3_fbsearch_places", "path": "/v3/fbsearch/places", "method": "GET", "description": "Search places (locations)", "parameters": [ { "name": "query", "optional": false, "description": "Search keyword (username or name)." }, { "name": "cache_timeout", "optional": true, "description": "Caching is disabled by default. Set a value greater than 0 to enable response caching for the specified number of seconds; repeated requests within this window will be served from cache and will not consume API request quota. Set 0 to keep caching disabled." } ] } ], "live_checks": [ { "path": "/v1/user/by/username", "parameters": { "username": "apple" }, "status": "ok", "observed_at": "2026-10-25T18:28:06.485238+00:00", "response_schema": { "status": "str", "ig": { "pk": "int", "username": "str", "full_name": "str", "is_private": "bool", "is_verified": "bool", "media_count": "int", "follower_count": "int", "following_count": "int", "biography": "str" } } } ] } } }