{ "openapi": "3.0.1", "info": { "title": "Whop Marketplace Scraper", "description": "Find public Whop products by keyword, URL, category, or leaderboard. Get available prices, company and creator details, ratings, reviews, and GMV, or collect daily keyword GMV reports for market research.", "version": "0.0", "x-build-id": "h8jcYLkPwrZ321qJb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~whop-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-whop-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/maximedupre~whop-scraper/runs": { "post": { "operationId": "runs-sync-maximedupre-whop-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/maximedupre~whop-scraper/run-sync": { "post": { "operationId": "run-sync-maximedupre-whop-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": [ "resultType" ], "properties": { "resultType": { "title": "Result type", "enum": [ "products", "keywordGmv" ], "type": "string", "description": "Choose product rows or daily keyword GMV reports for the past 90 days." }, "productUrls": { "title": "Product URLs", "type": "array", "description": "Add complete public Whop product URLs. These products join any other product searches in this run.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "companyUrls": { "title": "Company or community URLs", "type": "array", "description": "Add complete public Whop company or community URLs to find their products.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "categories": { "title": "Categories", "type": "array", "description": "Enter Whop category names or slugs. Find products in these categories, or use them to filter your keyword, URL, and leaderboard results. Leave empty for any category. Current regular category slugs: games, french, ai, computer-science, game-show, personal-development, spirituality, misc, recreation, dating, careers, community, newsletters, religion, agencies, travel, trading, students, sports, sports-picks, social-media, saas, reselling, real-estate, podcasts, personal-finance, night-life, music, misc-services, local-shop, life-hacks, gaming, fitness, fashion, events, ecommerce, design, business, board-games, art.", "items": { "type": "string" } }, "leaderboard": { "title": "Include leaderboard products", "type": "boolean", "description": "Find products on Whop marketplace leaderboards. The product filters below also apply to these results.", "default": false }, "sortBy": { "title": "Product order", "enum": [ "relevance", "newest", "rating", "gmv" ], "type": "string", "description": "Choose the order for product discovery. When Company or community URLs has any URLs, choose only Relevance. With that list empty, keyword searches support Relevance or Newest. Newest also requires Include leaderboard products to be off. Highest rating requires Keywords and Company or community URLs to be empty. For Highest available GMV, fill Categories, leave Keywords and both URL lists empty, and turn off Include leaderboard products. This GMV order combines results from all selected categories and uses Whop's reported product gross merchandise value for the last 24 hours, in US dollars. Leave empty for relevance." }, "verification": { "title": "Verification", "enum": [ "all", "verified", "unverified" ], "type": "string", "description": "Keep products with the chosen Whop verification state. Leave empty to include both states." }, "pricing": { "title": "Pricing", "enum": [ "all", "free", "paid" ], "type": "string", "description": "Keep products offering free or paid plans. Leave empty for either kind." }, "planTypes": { "title": "Plan types", "type": "array", "description": "Keep products with any selected plan type. Leave empty for all plan types.", "items": { "type": "string", "enum": [ "subscription", "oneTime", "splitPayment" ], "enumTitles": [ "Subscription", "One-time payment", "Split payment" ] } }, "minPrice": { "title": "Minimum price (USD)", "minimum": 0, "type": "number", "description": "Keep products with a plan priced at least this many US dollars. Use the renewal amount for subscriptions and the initial amount for other plans." }, "maxPrice": { "title": "Maximum price (USD)", "minimum": 0, "type": "number", "description": "Keep products with a plan priced at most this many US dollars. Use the renewal amount for subscriptions and the initial amount for other plans. When both price bounds are set, the same plan must meet both." }, "minRating": { "title": "Minimum rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Keep products with a public rating at least this high, on a five-star scale." }, "minReviews": { "title": "Minimum review count", "minimum": 0, "type": "integer", "description": "Keep products with at least this many published reviews." }, "minActiveUsers": { "title": "Minimum active users", "minimum": 0, "type": "integer", "description": "Keep products with at least this many public active users." }, "minGmv": { "title": "Minimum product GMV (USD)", "minimum": 0, "type": "number", "description": "Keep products with Whop's reported product gross merchandise value for the last 24 hours at least this many US dollars. Products with no public GMV do not match this filter." }, "maxGmv": { "title": "Maximum product GMV (USD)", "minimum": 0, "type": "number", "description": "Keep products with Whop's reported product gross merchandise value for the last 24 hours at most this many US dollars. Products with no public GMV do not match this filter." }, "createdAfter": { "title": "Created on or after", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Keep products created on or after this date, in UTC." }, "createdBefore": { "title": "Created on or before", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Keep products created on or before this date, in UTC." }, "keywords": { "title": "Keywords", "type": "array", "description": "Enter one or more search terms. Products mode uses them to find products. Keyword GMV reports mode returns available daily observations for each term for the past 90 days and needs at least one term.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum results", "minimum": 0, "type": "integer", "description": "A positive value stops at this many results, or fewer if no more are available. Leave empty or use zero to collect all available results until none remain. For Keyword GMV reports, one result is one keyword report." } } }, "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 } } } } } } } } } }