{ "openapi": "3.0.1", "info": { "title": "Whop Content Rewards Scraper", "description": "Scrape the Whop Content Rewards directory: reward per 1K views, budget left, burn rate, days of runway, creators, payout per creator and a 0-100 opportunity score. Filter and sort. JSON, CSV, Excel.", "version": "1.0", "x-build-id": "QHKcAtLXt07oQgsY9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parsebird~whop-content-rewards-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parsebird-whop-content-rewards-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~whop-content-rewards-scraper/runs": { "post": { "operationId": "runs-sync-parsebird-whop-content-rewards-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~whop-content-rewards-scraper/run-sync": { "post": { "operationId": "run-sync-parsebird-whop-content-rewards-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": { "status": { "title": "Status", "enum": [ "active", "all" ], "type": "string", "description": "Which campaigns to include.", "default": "active" }, "minRewardPerThousand": { "title": "Min reward per 1,000 views (USD)", "minimum": 0, "type": "integer", "description": "Keep only campaigns paying at least this much per 1,000 views." }, "minBudgetLeftUsd": { "title": "Min budget left (USD)", "minimum": 0, "type": "integer", "description": "Keep only campaigns with at least this much unspent budget." }, "maxProgressPercentage": { "title": "Max progress (%)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Keep only campaigns that have consumed at most this share of their budget." }, "maxCreators": { "title": "Max creators", "minimum": 0, "type": "integer", "description": "Cap the competition. e.g. 300 keeps campaigns clippers have not piled into yet." }, "minPayoutPerCreatorUsd": { "title": "Min payout per creator (USD)", "minimum": 0, "type": "integer", "description": "Proof of payout. Average USD earned per creator so far must be at least this." }, "minEstimatedDaysLeft": { "title": "Min estimated days left", "minimum": 0, "type": "integer", "description": "Skip campaigns whose budget will drain within this many days at the current burn rate." }, "minOpportunityScore": { "title": "Min opportunity score", "minimum": 0, "maximum": 100, "type": "integer", "description": "One number instead of five filters. 0-100 composite (see the README)." }, "platforms": { "title": "Platforms", "type": "array", "description": "Keep campaigns that accept at least one of these platforms.", "items": { "type": "string", "enum": [ "tiktok", "instagram", "youtube", "x", "facebook" ], "enumTitles": [ "TikTok", "Instagram", "YouTube", "X", "Facebook" ] } }, "campaignTypes": { "title": "Campaign types", "type": "array", "description": "Keep campaigns of these types.", "items": { "type": "string", "enum": [ "clipping", "ugc", "both" ], "enumTitles": [ "Clipping", "UGC", "Both" ] } }, "categories": { "title": "Categories", "type": "array", "description": "Keep campaigns in these categories.", "items": { "type": "string", "enum": [ "Entertainment", "Music", "Personal Brand", "Product", "Technology", "Gaming", "Slideshow", "Logo", "Other" ], "enumTitles": [ "Entertainment", "Music", "Personal Brand", "Product", "Technology", "Gaming", "Slideshow", "Logo", "Other" ] } }, "searchText": { "title": "Search text", "type": "string", "description": "Case-insensitive match against title, brand, description and category." }, "sortBy": { "title": "Sort by", "enum": [ "budgetLeft", "opportunity", "reward", "payoutPerCreator", "burn", "daysLeft", "fewestCreators", "newest", "progress" ], "type": "string", "description": "Order of the returned campaigns (best first).", "default": "budgetLeft" }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Maximum campaigns to return. You are only charged for returned results." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. The default Apify Proxy is enough.", "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 } } } } } } } } } }