{ "openapi": "3.0.1", "info": { "title": "Whatnot Data Scraper", "description": "Extract product listings and discover live auction streams from Whatnot.com", "version": "0.0", "x-build-id": "fVbO8EP5qUatsEzSX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/devcake~whatnot-data-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-devcake-whatnot-data-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/devcake~whatnot-data-scraper/runs": { "post": { "operationId": "runs-sync-devcake-whatnot-data-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/devcake~whatnot-data-scraper/run-sync": { "post": { "operationId": "run-sync-devcake-whatnot-data-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": [ "proxyConfiguration" ], "properties": { "mode": { "title": "Scraper Mode", "enum": [ "searchProducts", "searchLiveStreams", "browseCategories" ], "type": "string", "description": "Choose what you want to scrape" }, "searchKeywords": { "title": "Search Keywords", "minItems": 1, "type": "array", "description": "Used for: Search Products mode OR Find Live Streams mode. Enter keywords to find specific items (e.g., Pokemon cards, Nike sneakers, Vintage comics)", "items": { "type": "string" } }, "categories": { "title": "Categories", "uniqueItems": true, "type": "array", "description": "Used for: Browse Live Streams mode only. Select categories to explore live streams. Not used for keyword search modes.", "items": { "type": "string", "enum": [ "Trading Card Games", "Entertainment Cards", "Sports Cards", "Sports Memorabilia", "Sports & Outdoors", "Anime & Manga", "Comics", "Video Games", "Toys & Hobbies", "Sneakers & Streetwear", "Electronics", "Coins & Money", "Jewelry", "Beauty", "Women's Fashion", "Men's Fashion", "Bags & Accessories", "Home & Garden", "Antiques & Vintage Decor", "Arts & Handmade", "Baby & Kids", "Pets", "Food & Drink", "Music", "Books & Movies", "Rocks & Crystals", "Knives & Hunting", "Wholesale & Deals", "Estate Sales & Storage Units", "and Whatnot" ] } }, "maxResults": { "title": "Maximum Results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum items to extract per query (search mode) or per category (browse mode)", "default": 50 }, "enrichSellerData": { "title": "Enrich Seller Data", "type": "boolean", "description": "Enhance results with additional seller information (followers, sold count, verified status). Adds 1 API call per unique seller.", "default": true }, "maxSellerEnrichment": { "title": "Max Seller Enrichment", "minimum": 0, "maximum": 500, "type": "integer", "description": "Maximum number of unique sellers to enrich per keyword/category. Set to a lower number to avoid timeouts when scraping large result sets. 0 = no limit.", "default": 20 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Configure proxy settings for accessing Whatnot (required to avoid 403 errors)", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }