{ "openapi": "3.0.1", "info": { "title": "Whatnot Scraper – Extract Seller, Search & Category Data", "description": "Scrape Whatnot.com at scale – search results, seller profiles, reviews, live shows, shop listings, auctions, category leaderboards & more. Fast, reliable and no auth required. Export as JSON, CSV, XML or Excel. Search by keyword or URL, analyze sellers in bulk, or browse and deep-into any category.", "version": "0.2", "x-build-id": "2gFeIWpNvraNZeKaV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/epicscrapers~whatnot-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-epicscrapers-whatnot-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/epicscrapers~whatnot-scraper/runs": { "post": { "operationId": "runs-sync-epicscrapers-whatnot-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/epicscrapers~whatnot-scraper/run-sync": { "post": { "operationId": "run-sync-epicscrapers-whatnot-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "seller", "category" ], "type": "string", "description": "Select the scraping mode. Search: search by URL or text query. Seller: get seller profile, shows, reviews, and shop listings. Category: list, trend, deep-dive, or explore categories." }, "searchUrls": { "title": "Search URLs", "type": "array", "description": "List of Whatnot search URLs (e.g. \"https://www.whatnot.com/search?query=pokemon&searchVertical=PRODUCT\"). Each URL is parsed independently for query, vertical, sort, and other params. The vertical and include* toggles in the Query Search section do NOT apply to URLs.", "items": { "type": "string" } }, "searchQueries": { "title": "Search Queries", "type": "array", "description": "List of search terms (e.g. \"pokemon cards\", \"sneakers\"). Each query runs against the selected vertical (or UNIVERSAL for a mix of all types). Multiple queries run in sequence, results are merged.", "items": { "type": "string" } }, "vertical": { "title": "Search Vertical", "enum": [ "UNIVERSAL", "LIVESTREAM", "PRODUCT", "USER", "CATEGORY" ], "type": "string", "description": "Filter search results to specific content types. UNIVERSAL searches across all types. Use LIVESTREAM for active streams, PRODUCT for catalog items, USER for seller profiles, or CATEGORY for product categories. Only applies to searchQueries; searchUrls use each URL's own searchVertical param.", "default": "PRODUCT" }, "includeListings": { "title": "Include Listings", "type": "boolean", "description": "Whether to extract individual item listings (buy-it-now or auction items). Disable if you only want livestreams, products, or users. Only applies to query-based searches, not URL-based.", "default": true }, "includeLivestreams": { "title": "Include Livestreams", "type": "boolean", "description": "Whether to extract active livestreams from search results. Only applies to query-based searches, not URL-based.", "default": true }, "includeProducts": { "title": "Include Products", "type": "boolean", "description": "Whether to extract product catalog entries with aggregated pricing data. Only applies to query-based searches, not URL-based.", "default": true }, "includeUsers": { "title": "Include Users", "type": "boolean", "description": "Whether to extract user/seller profiles from search results. Only applies to query-based searches, not URL-based.", "default": false }, "includeCategories": { "title": "Include Categories", "type": "boolean", "description": "Whether to include related category tags (LivestreamTagNode) in search results. These show category names and viewer counts (e.g. \"Pokémon Cards\" with 18K viewers). Disabled by default since they crowd out listing results. Only applies to query-based searches, not URL-based.", "default": false }, "maxResultsPerQuery": { "title": "Max Results Per Query / URL", "minimum": 1, "maximum": 10000000, "type": "integer", "description": "Overrides Max Results. Each query or URL gets up to this many results (instead of having maxResults divided equally).", "default": 100 }, "usernames": { "title": "Usernames", "type": "array", "description": "List of usernames (e.g. \"ah_sneakers\"). All entries are processed, one result per seller.", "items": { "type": "string" } }, "userIds": { "title": "User IDs", "type": "array", "description": "List of numeric user IDs (e.g. \"18249573\"). Alternative to usernames. All entries are processed, one result per seller.", "items": { "type": "string" } }, "includeProfile": { "title": "Include Profile", "type": "boolean", "description": "Include seller profile data (bio, rating, follower count, etc.).", "default": true }, "includeShows": { "title": "Include Shows", "type": "boolean", "description": "Include show schedule (live and upcoming streams).", "default": true }, "includeReviews": { "title": "Include Reviews", "type": "boolean", "description": "Include buyer reviews and ratings with distribution analysis.", "default": true }, "includeShop": { "title": "Include Shop Listings", "type": "boolean", "description": "Include active shop listings (buy-it-now and auction items).", "default": false }, "query": { "title": "Search Query", "type": "string", "description": "Search query within a seller's shop listings (seller mode)." }, "filters": { "title": "Shop Filters", "type": "array", "description": "Additional filters for shop listings (seller mode). Each filter has a field and values array (e.g. [{\"field\": \"buyingFormat\", \"values\": [\"ASYNC_AUCTION\"]}])." }, "categoryView": { "title": "Category View", "enum": [ "list", "trending", "deep-dive", "explore" ], "type": "string", "description": "Select what kind of category data to fetch. See section description for details.", "default": "list" }, "categoryTagId": { "title": "Categories", "type": "array", "description": "Select one or more categories. Required for deep-dive view. Optional for explore view (limits which categories to explore). Top-level entries show \"(All)\" — choose subcategories for finer granularity.", "items": { "type": "string", "enum": [ "Trading Card Games (All)", "Trading Card Games > Pokémon Cards", "Trading Card Games > Magic: The Gathering", "Trading Card Games > Yu-Gi-Oh! Cards", "Trading Card Games > One Piece Cards", "Trading Card Games > Weiß Schwarz", "Trading Card Games > VeeFriends", "Trading Card Games > Dragon Ball Cards", "Trading Card Games > Naruto Cards", "Trading Card Games > Union Arena", "Trading Card Games > Other TCG", "Trading Card Games > Riftbound", "Trading Card Games > Lorcana", "Books & Movies (All)", "Books & Movies > Books", "Books & Movies > Movies", "Books & Movies > Movie Memorabilia", "Sports Cards (All)", "Sports Cards > Football Cards", "Sports Cards > Basketball Cards", "Sports Cards > Baseball Cards", "Sports Cards > Soccer Cards", "Sports Cards > UFC Cards", "Sports Cards > Wrestling Cards", "Sports Cards > F1 Cards", "Sports Cards > NASCAR Cards", "Sports Cards > Hockey Cards", "Toys & Hobbies (All)", "Toys & Hobbies > Funko", "Toys & Hobbies > Disney", "Toys & Hobbies > Action Figures", "Toys & Hobbies > LEGO", "Toys & Hobbies > Bearbrick", "Toys & Hobbies > Diecast", "Toys & Hobbies > Other Designer Toys", "Toys & Hobbies > Labubu & Blind Boxes", "Toys & Hobbies > Kawaii", "Toys & Hobbies > Sonny Angels & Smiskis", "Toys & Hobbies > Plush", "Toys & Hobbies > RC Vehicles & Toys", "Toys & Hobbies > Dolls", "Toys & Hobbies > Star Wars", "Toys & Hobbies > Models & Kits", "Toys & Hobbies > FigPin", "Toys & Hobbies > Baby & Kids Toys", "Toys & Hobbies > Vintage Toys", "Toys & Hobbies > Thrilljoy", "Toys & Hobbies > Board Games & Puzzles", "Toys & Hobbies > Slime & Squishy Toys", "Toys & Hobbies > Littlest Pet Shop", "Toys & Hobbies > Loungefly", "Toys & Hobbies > RPG & Miniatures", "Electronics (All)", "Electronics > Everyday Electronics", "Electronics > Cameras & Photography", "Electronics > Tools", "Electronics > Laptops, Phones & Tablets", "Electronics > Headphones & Speakers", "Electronics > Home Appliances", "Coins & Money (All)", "Coins & Money > Coins & Bullion", "Coins & Money > Paper Money & Currency", "Coins & Money > Ancient Coins", "Coins & Money > Gold Nuggets", "Estate Sales & Storage Units (All)", "Estate Sales & Storage Units > Estate Sales", "Estate Sales & Storage Units > Storage Unit Finds", "Estate Sales & Storage Units > Garage Sales", "Sports Memorabilia (All)", "Sports Memorabilia > Football Memorabilia", "Sports Memorabilia > Basketball Memorabilia", "Sports Memorabilia > Baseball Memorabilia", "Sports Memorabilia > Soccer Memorabilia", "Men's Fashion (All)", "Men's Fashion > Men's Vintage Clothing", "Men's Fashion > Men's Modern", "Men's Fashion > Men's Big & Tall Fashion", "Men's Fashion > Other Men's Fashion", "Men's Fashion > Sports Apparel", "Men's Fashion > Men's Activewear", "Men's Fashion > Streetwear", "Men's Fashion > Men's Formalwear", "Sneakers & Shoes (All)", "Sneakers & Shoes > Sneakers", "Sneakers & Shoes > Women's Shoes", "Sneakers & Shoes > Baby & Kids Shoes", "Women's Fashion (All)", "Women's Fashion > Women's Vintage Clothing", "Women's Fashion > Y2K", "Women's Fashion > Women's Contemporary", "Women's Fashion > Women's Activewear", "Women's Fashion > Bags & Accessories", "Women's Fashion > Women's Boutiques", "Women's Fashion > Women's Plus Size", "Women's Fashion > Women's Swimwear", "Women's Fashion > Women's Dresses", "Bags & Accessories > Luxury Bags & Accessories", "Bags & Accessories > Contemporary Bags", "Bags & Accessories > Sunglasses & Eyewear", "Bags & Accessories > Vintage Bags", "Beauty (All)", "Beauty > Makeup & Skincare", "Beauty > Nails", "Beauty > Fragrances & Perfume", "Beauty > Hair Products & Wigs", "Beauty > Men's Grooming", "Beauty > Bath & Body Essentials", "Jewelry & Watches (All)", "Jewelry & Watches > Gold & Silver Jewelry", "Jewelry & Watches > Vintage & Antique Jewelry", "Jewelry & Watches > Other Jewelry", "Jewelry & Watches > Handcrafted Jewelry", "Jewelry & Watches > Men's Jewelry", "Jewelry & Watches > Western & Southwestern Jewelry", "Jewelry & Watches > Watches", "Jewelry & Watches > Diamonds & Gemstones", "Jewelry & Watches > Women's Jewelry", "Music (All)", "Music > Vinyl Records", "Music > CDs & Cassettes", "Music > Music Memorabilia", "Video Games (All)", "Video Games > Retro Games", "Video Games > Consoles & Accessories", "Video Games > Modern Games", "Video Games > Guides, Manuals & Cases", "Antiques & Vintage Decor (All)", "Antiques & Vintage Decor > Antiques", "Antiques & Vintage Decor > Vintage Decor", "Antiques & Vintage Decor > Ephemera", "Antiques & Vintage Decor > Postage Stamps", "Home & Garden (All)", "Home & Garden > Home Decor", "Home & Garden > Plants & Garden", "Home & Garden > Kitchen & Dining", "Home & Garden > Holiday Decor", "Home & Garden > Tumblers & Water Bottles", "Home & Garden > Other Home & Garden", "Home & Garden > Candles", "Rocks & Crystals (All)", "Rocks & Crystals > Crystals & Gems", "Rocks & Crystals > Fossils", "Rocks & Crystals > Other Rocks", "Baby & Kids (All)", "Baby & Kids > Baby & Kids Clothes", "Baby & Kids > Baby & Kids Supplies", "Arts & Handmade (All)", "Arts & Handmade > Quilting, Sewing & Fabrics", "Arts & Handmade > Knitting & Crochet", "Arts & Handmade > Beads, Pens & Keychains", "Arts & Handmade > Woodworking", "Arts & Handmade > Heat Transfers & Wraps", "Arts & Handmade > 3D Prints", "Arts & Handmade > Embroidery & Needlework", "Arts & Handmade > Scrapbook & Journaling", "Arts & Handmade > Stickers", "Arts & Handmade > Resin Art", "Arts & Handmade > Craft Stamps", "Arts & Handmade > Glass Art", "Arts & Handmade > Jewelry Making Supplies", "Comics (All)", "Comics > Modern Comics", "Comics > Vintage Comics", "Outdoors & Hunting (All)", "Outdoors & Hunting > Tactical Gear", "Outdoors & Hunting > Knives & EDC", "Outdoors & Hunting > Fishing", "Outdoors & Hunting > Camping & Hiking Gear", "Wholesale & Deals (All)", "Wholesale & Deals > Pallets", "Wholesale & Deals > Case Packs & Bundles", "Wholesale & Deals > Deal Hunting", "Anime & Manga (All)", "Food & Drink (All)", "Food & Drink > Baked Goods", "Food & Drink > Candy & Snacks", "Food & Drink > Other Food & Drink", "Food & Drink > Fresh & Specialty Food", "Food & Drink > Supplements", "Food & Drink > Coffee & Tea", "Food & Drink > Chocolate", "Food & Drink > Condiments & Sauces", "Food & Drink > Soda & Drinks", "Food & Drink > Exotic Snacks", "and Whatnot (All)", "and Whatnot > Everything Else", "and Whatnot > Community", "Entertainment Cards (All)", "Entertainment Cards > TV & Movie Cards", "Entertainment Cards > Other Entertainment Cards", "Entertainment Cards > Star Wars Cards", "Entertainment Cards > Garbage Pail Kids", "Entertainment Cards > Marvel Cards", "Entertainment Cards > Disney Cards", "Sporting Goods (All)", "Sporting Goods > Cycling", "Sporting Goods > Other Sporting Goods", "Sporting Goods > Disc Golf", "Sporting Goods > Racquet Sports", "Sporting Goods > Golf", "Sporting Goods > Baseball & Softball", "Sporting Goods > Winter Sports", "Sporting Goods > Football Gear", "Sporting Goods > Soccer Gear", "Sporting Goods > Skateboard Gear", "Pets (All)", "Pets > Dog & Cat", "Pets > Pet Fish", "Pets > Other Pets", "Pets > Horse Tack" ] } }, "categoryTagIdsRaw": { "title": "Raw Category Tag IDs", "type": "array", "description": "Paste raw base64-encoded category tag IDs directly (e.g. \"TGl2ZXN0cmVhbVRhZ05vZGU6ODk5\"). These are appended to any categories selected above. Useful for categories not listed in the dropdown.", "items": { "type": "string" } }, "fetchDetails": { "title": "Fetch Details", "type": "boolean", "description": "Get metadata, subcategories, and filter/sort options. Only used by deep-dive view.", "default": true }, "fetchShows": { "title": "Fetch Shows", "type": "boolean", "description": "Get live/upcoming shows. Only used by deep-dive view.", "default": true }, "fetchRankings": { "title": "Fetch Rankings", "type": "boolean", "description": "Get seller leaderboard. Only used by deep-dive view.", "default": false }, "includeSubcategories": { "title": "Include Subcategories", "type": "boolean", "description": "Fetch subcategory/refinement data. Used by deep-dive (details) and explore views.", "default": true }, "showStatus": { "title": "Show Status Filter", "enum": [ "live", "upcoming", "all" ], "type": "string", "description": "Filter shows by live status. \"live\" returns currently streaming shows (PLAYING), \"upcoming\" returns scheduled shows (CREATED), \"all\" returns both. Used by seller shows and deep-dive shows.", "default": "live" }, "sort": { "title": "Sort Field (Shows)", "enum": [ "VIEWER_COUNT", "TITLE" ], "type": "string", "description": "Field to sort shows by. Used by deep-dive shows.", "default": "VIEWER_COUNT" }, "sortDirection": { "title": "Sort Direction (Shows)", "enum": [ "ASC", "DESC" ], "type": "string", "description": "Sort direction for shows in deep-dive view.", "default": "DESC" }, "sortBy": { "title": "Sort By (Trending)", "enum": [ "VIEWER_COUNT", "TITLE" ], "type": "string", "description": "Sort field for trending categories view.", "default": "VIEWER_COUNT" }, "type": { "title": "Leaderboard Type", "enum": [ "OVERALL" ], "type": "string", "description": "Type of leaderboard for deep-dive rankings.", "default": "OVERALL" }, "interval": { "title": "Leaderboard Interval", "enum": [ "CURRENT_DAY", "CURRENT_WEEK", "LIVE" ], "type": "string", "description": "Time interval for deep-dive rankings. CURRENT_DAY = today, CURRENT_WEEK = this week, LIVE = live (may be empty).", "default": "CURRENT_DAY" }, "maxResults": { "title": "Max Results (Default)", "minimum": 1, "maximum": 500, "type": "integer", "description": "Default limit across all modes. Individual limits below override this when set.", "default": 100 }, "maxShows": { "title": "Max Shows", "minimum": 1, "maximum": 200, "type": "integer", "description": "Limit for live streams. Overrides Max Results. Default: 25. Used by: seller & deep-dive.", "default": 25 }, "maxReviews": { "title": "Max Reviews", "minimum": 1, "maximum": 500, "type": "integer", "description": "Limit for buyer reviews. Overrides Max Results. Default: 50. Used by: seller.", "default": 50 }, "maxListings": { "title": "Max Listings / Sold Items", "minimum": 1, "maximum": 200, "type": "integer", "description": "Limit for shop listings (buy-it-now & auction). Overrides Max Results. Default: 50. Used by: seller.", "default": 50 }, "maxCategories": { "title": "Max Categories", "minimum": 1, "maximum": 100, "type": "integer", "description": "Limit for top-level categories. Overrides Max Results. Default: 25. Used by: list, trending & explore.", "default": 25 }, "maxShowsPerCategory": { "title": "Max Shows Per Category", "minimum": 1, "maximum": 50, "type": "integer", "description": "Limit for live shows per category during explore. Default: 5.", "default": 5 }, "cookies": { "title": "Cookies (Optional)", "type": "string", "description": "Browser cookies from an authenticated Whatnot.com session. Required for accessing personalized results and following status. To get cookies: log into Whatnot.com, open Dev Tools, copy the Cookie header from any request." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Select proxies to be used by your scraper." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }