{ "openapi": "3.0.1", "info": { "title": "Whatnot Seller Scraper", "description": "Scrape Whatnot sellers, listings, live shows and categories: seller ratings, followers, sold count, buyer reviews, shop listings, prices, bids, viewers and seller leaderboards. Search by keyword, URL, username or category. Export JSON, CSV or Excel.", "version": "1.0", "x-build-id": "UEBQhiGIDbI69JEIB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parsebird~whatnot-seller-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parsebird-whatnot-seller-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/parsebird~whatnot-seller-scraper/runs": { "post": { "operationId": "runs-sync-parsebird-whatnot-seller-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/parsebird~whatnot-seller-scraper/run-sync": { "post": { "operationId": "run-sync-parsebird-whatnot-seller-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", "properties": { "resultType": { "title": "What to scrape", "enum": [ "listings", "liveShows", "sellerProfiles", "categoryInsights", "mixedSearch" ], "type": "string", "description": "Pick the kind of Whatnot records to return. Mixed search returns listings, live shows and seller profiles for the same input.", "default": "listings" }, "findBy": { "title": "Find by", "enum": [ "keywords", "searchUrls", "directUrls", "sellerUsernames", "category" ], "type": "string", "description": "Choose how to find records, then fill in the matching field below. Category insights work with category, keywords or category URLs (or leave the category empty to get every top-level category).", "default": "keywords" }, "keywords": { "title": "Keywords", "type": "array", "description": "Enter one or more search terms, the same as typing them into Whatnot search. With seller usernames or seller URLs, the keywords instead search inside each seller's shop.", "items": { "type": "string" } }, "searchUrls": { "title": "Search URLs", "type": "array", "description": "Paste Whatnot search result URLs such as https://www.whatnot.com/search?query=pokemon. Filters and sort order in the URL are kept for the matching search tab.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "directUrls": { "title": "Direct URLs", "type": "array", "description": "Paste listing (/listing/...), live show (/live/...), seller (/user/...) or category (/tag/...) URLs.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "sellerUsernames": { "title": "Seller usernames", "type": "array", "description": "Enter Whatnot usernames (the part after whatnot.com/user/) or seller IDs. Works for seller profiles, a seller's shop listings, or a seller's live shows.", "items": { "type": "string" } }, "category": { "title": "Category", "type": "string", "description": "Enter a Whatnot category name or slug, for example Trading Card Games, pokemon_cards or Sneakers." }, "maxItems": { "title": "Max results", "minimum": 1, "type": "integer", "description": "Maximum number of records to save. Leave empty to collect everything Whatnot returns. In mixed search the limit is split evenly between listings, live shows and seller profiles." }, "saleFormats": { "title": "Sale formats", "type": "array", "description": "Keep only listings sold this way.", "items": { "type": "string", "enum": [ "auction", "buyNow" ], "enumTitles": [ "Auction", "Buy It Now" ] } }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "number", "description": "Keep listings at or above this price (in the listing currency, e.g. 10 for $10)." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "number", "description": "Keep listings at or below this price." }, "liveOnly": { "title": "Only listings in a live show", "type": "boolean", "description": "Keep only listings that Whatnot marks as being sold in a live show right now.", "default": false }, "listingOrder": { "title": "Listing sort order", "enum": [ "relevance", "newest", "priceLowToHigh", "priceHighToLow" ], "type": "string", "description": "Order of listing results.", "default": "relevance" }, "monitorChanges": { "title": "Track changes since the last run", "type": "boolean", "description": "Compare each listing with the previous run of the same search and mark it as new, changed (price, quantity, status, bids) or unchanged. A summary with listings no longer found is saved as MONITOR_SUMMARY.", "default": false }, "includeReviews": { "title": "Include buyer reviews", "type": "boolean", "description": "Add public buyer reviews (star ratings for overall, shipping, packaging and accuracy, review text, seller reply, date and reviewer) with a star distribution.", "default": false }, "maxReviewsPerSeller": { "title": "Max reviews per seller", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Most reviews to collect for each seller when buyer reviews are included.", "default": 50 }, "includeShowHistory": { "title": "Include show history", "type": "boolean", "description": "Add the seller's past and scheduled live shows.", "default": false }, "maxShowHistoryPerSeller": { "title": "Max shows per seller", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Most shows to list for each seller when show history is included.", "default": 20 }, "maxShopListingsPerSeller": { "title": "Max shop listings per seller", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Most shop listings to include in each seller profile. Set 0 to skip the shop.", "default": 20 }, "categoryFilters": { "title": "Category show filters", "type": "array", "description": "Filter the shows of a category by any filter on its Whatnot page, by name: Live, Upcoming, Auction, Breaks, Singles, Graded, Premier Shop, a country (United States), a subcategory or a tag. Applies to category insights and category live shows.", "items": { "type": "string" } }, "categoryOrder": { "title": "Category order", "enum": [ "popular", "viewerCount", "livestreamCount", "name", "newest" ], "type": "string", "description": "Order of categories and subcategories.", "default": "popular" }, "leaderboardPeriod": { "title": "Seller leaderboard period", "enum": [ "today", "week", "live" ], "type": "string", "description": "Period of the category seller leaderboard, when Whatnot publishes one.", "default": "today" }, "maxShowsPerCategory": { "title": "Max shows per category", "minimum": 0, "maximum": 500, "type": "integer", "description": "Most live and upcoming shows to list inside each category insight.", "default": 20 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Not needed in most cases. The Actor connects directly and switches to Apify Proxy on its own if Whatnot starts refusing requests." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }