{ "openapi": "3.0.1", "info": { "title": "Whatnot Scraper - Listings, Live Shows and Sellers", "description": "Search Whatnot like its own search box and get rows: listings with price, format, status and seller; live and upcoming shows with viewers and start time; seller profiles with followers, sold count and rating. Every filter Whatnot's search offers. No login or API key.", "version": "0.1", "x-build-id": "k0z1CCgrPo7b5EdUT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dami_studio~whatnot-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dami_studio-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/dami_studio~whatnot-scraper/runs": { "post": { "operationId": "runs-sync-dami_studio-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/dami_studio~whatnot-scraper/run-sync": { "post": { "operationId": "run-sync-dami_studio-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": { "searchFor": { "title": "What to get", "enum": [ "listings", "liveShows", "sellers" ], "type": "string", "description": "Listings are items for sale. Live shows are Whatnot's streams, live now or scheduled. Sellers are profiles with followers, items sold and rating.", "default": "listings" }, "keywords": { "title": "Search words", "maxItems": 20, "type": "array", "description": "What you'd type into Whatnot's search box, one search per line. Leave it empty if you only want the sellers below.", "items": { "type": "string" } }, "sellerUsernames": { "title": "Seller usernames", "maxItems": 100, "type": "array", "description": "Whatnot usernames, with or without the @, or links to their profiles. For listings you get what's in each seller's shop (searched with your words if you gave any). For live shows, each seller's live and upcoming shows. For sellers, their profiles.", "items": { "type": "string" } }, "maxResultsPerSearch": { "title": "Results per search", "minimum": 1, "maximum": 10000, "type": "integer", "description": "The most rows from one search word or one seller. Whatnot itself stops a listing search after roughly the first thousand results.", "default": 100 }, "maxResults": { "title": "Results in total", "minimum": 1, "maximum": 10000, "type": "integer", "description": "The most rows in the whole run. Each row returned is one charge.", "default": 1000 }, "category": { "title": "Category", "maxItems": 20, "type": "array", "description": "Category names as Whatnot shows them, such as Pokémon Cards or Sneakers. Each search uses the ones Whatnot offers for it. A search where none of yours appear returns nothing, rather than other categories.", "items": { "type": "string" } }, "minSellerRating": { "title": "Minimum seller rating", "enum": [ "any", "4.0", "4.5", "5.0" ], "type": "string", "description": "Only sellers rated at least this well.", "default": "any" }, "premierShopsOnly": { "title": "Premier shops only", "type": "boolean", "description": "Only sellers Whatnot has made Premier Shops.", "default": false }, "shipsFrom": { "title": "Ships from", "type": "array", "description": "Only sellers shipping from these countries. Leave it empty for all.", "items": { "type": "string", "enum": [ "US", "GB", "CA", "AU", "DE", "FR", "NL", "BE", "AT", "ES", "JP" ], "enumTitles": [ "United States", "United Kingdom", "Canada", "Australia", "Germany", "France", "Netherlands", "Belgium", "Austria", "Spain", "Japan" ] } }, "sortBy": { "title": "Sort", "enum": [ "relevance", "priceLowToHigh", "priceHighToLow", "newest", "viewersHighToLow", "viewersLowToHigh" ], "type": "string", "description": "Price and newly listed are for listings, viewers for live shows. Whatnot sorts prices as numbers, so a list that mixes currencies isn't in true price order; pick one country under Ships from if that matters.", "default": "relevance" }, "buyingFormat": { "title": "Buying format", "enum": [ "any", "buyItNow", "auction" ], "type": "string", "description": "Buy It Now items, or items sold at auction in a live show.", "default": "any" }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "number", "description": "In each listing's own currency, such as 10 for $10.00 or €10.00." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "number", "description": "In each listing's own currency. Yen listings rarely fit a range meant for dollars; see the README." }, "condition": { "title": "Condition", "maxItems": 20, "type": "array", "description": "Condition labels as sellers write them, such as Near Mint, New or Used. Whatnot matches the label, so spelling counts.", "items": { "type": "string" } }, "gradedOnly": { "title": "Graded only", "type": "boolean", "description": "Only items the seller marked as graded.", "default": false }, "autographedOnly": { "title": "Autographed only", "type": "boolean", "description": "Only items the seller marked as autographed.", "default": false }, "itemDetails": { "title": "More item details", "type": "object", "description": "Other details Whatnot filters on, by name, for example {\"Language\": [\"Japanese\"], \"Set\": [\"Base Set\"]}. For trading cards Whatnot offers Language, Product Type, Set, Card Number, Rarity, Grade, Grading Service and Cert. Other categories can have their own." }, "showStatus": { "title": "Show status", "enum": [ "any", "liveNow", "upcoming" ], "type": "string", "description": "Shows streaming right now, or shows scheduled for later.", "default": "any" }, "showFormat": { "title": "Show format", "type": "array", "description": "The kind of show, as the seller set it up.", "items": { "type": "string", "enum": [ "auction", "breaks", "buyItNow", "graded", "singles", "surpriseSets" ], "enumTitles": [ "Auction", "Breaks", "Buy It Now", "Graded", "Singles", "Surprise sets" ] } }, "brands": { "title": "Brands", "maxItems": 20, "type": "array", "description": "Brands Whatnot tags shows with, such as Disney or Nike.", "items": { "type": "string" } }, "tags": { "title": "Tags", "maxItems": 20, "type": "array", "description": "Show tags as Whatnot shows them, such as $1 Starts or Vintage.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }