{ "openapi": "3.0.1", "info": { "title": "Whatnot Scraper - Listings, Live Shows, Sellers & Reviews", "description": "[Limited Launch Offer $2.50/1K] Whatnot API for listings and auctions (prices, current bid, bids), live shows with viewers, seller profiles, shops and buyer reviews. Search or paste links. No login.", "version": "0.1", "x-build-id": "yK4fwoQknkY4cfJb3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kalilfagundes.w~whatnot-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kalilfagundes.w-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/kalilfagundes.w~whatnot-scraper/runs": { "post": { "operationId": "runs-sync-kalilfagundes.w-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/kalilfagundes.w~whatnot-scraper/run-sync": { "post": { "operationId": "run-sync-kalilfagundes.w-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", "properties": { "searchQueries": { "title": "Search queries (searchQueries)", "type": "array", "description": "Keywords as typed in the Whatnot search box (\"charizard\", \"funko pop\").", "items": { "type": "string" } }, "searchType": { "title": "Search for (searchType)", "enum": [ "listings", "livestreams", "both" ], "type": "string", "description": "What the search queries return.", "default": "listings" }, "sellers": { "title": "Sellers (sellers)", "type": "array", "description": "Usernames or profile links (https://www.whatnot.com/user/): one seller row each, plus their shop, reviews and shows (options below).", "items": { "type": "string" } }, "startUrls": { "title": "Whatnot links (startUrls)", "type": "array", "description": "Listing (/listing/...), live show (/live/...: the show and the items in its shop), seller (/user/...) or category (/tag/..., /category/...: its live and upcoming shows) links.", "items": { "type": "string" } }, "buyingFormat": { "title": "Buying format (buyingFormat)", "enum": [ "any", "auction", "buy_it_now" ], "type": "string", "description": "For listing searches and seller shops.", "default": "any" }, "minPrice": { "title": "Min price (minPrice)", "minimum": 0, "type": "integer", "description": "In the listing currency." }, "maxPrice": { "title": "Max price (maxPrice)", "minimum": 0, "type": "integer", "description": "In the listing currency." }, "sort": { "title": "Sort listings (sort)", "enum": [ "best_match", "newest", "price_low_to_high", "price_high_to_low" ], "type": "string", "description": "Order of listing results.", "default": "best_match" }, "liveStatus": { "title": "Shows (liveStatus)", "enum": [ "all", "live", "upcoming" ], "type": "string", "description": "For show searches and category links.", "default": "all" }, "includeSellerListings": { "title": "Seller shop listings (includeSellerListings)", "type": "boolean", "description": "Items in each seller's shop.", "default": true }, "includeSellerReviews": { "title": "Seller reviews (includeSellerReviews)", "type": "boolean", "description": "Buyer reviews with shipping / packaging / accuracy ratings, newest first.", "default": false }, "includeSellerShows": { "title": "Seller shows (includeSellerShows)", "type": "boolean", "description": "The seller's live and scheduled shows.", "default": false }, "includeShowItems": { "title": "Items in live show links (includeShowItems)", "type": "boolean", "description": "For /live/ links: also the auctions and buy-it-now items in the show's shop.", "default": true }, "maxItemsPerSource": { "title": "Rows per source (maxItemsPerSource)", "minimum": 0, "type": "integer", "description": "Per search query, per seller shop / reviews / shows, per link. 0 = all (Whatnot serves up to ~10,000 results per search).", "default": 100 }, "maxItems": { "title": "Maximum rows in total (maxItems)", "minimum": 0, "type": "integer", "description": "Stop after this many rows in the whole run. 0 = no limit.", "default": 1000 }, "proxyConfiguration": { "title": "Proxy (proxyConfiguration)", "type": "object", "description": "Requests go direct; the proxy is used only if Whatnot refuses them.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }