{ "openapi": "3.0.1", "info": { "title": "Whop Content Rewards Scraper", "description": "Extract every Whop Content Rewards campaign: per-platform payout rates, budget burn rate, creator counts, approval rates, and brand trust data. Track clipping and UGC campaigns and their real economics without clicking through each card.", "version": "1.0", "x-build-id": "bvsDiD172K2wmKJBy" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/citrine_venus~whop-content-rewards-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-citrine_venus-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/citrine_venus~whop-content-rewards-scraper/runs": { "post": { "operationId": "runs-sync-citrine_venus-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/citrine_venus~whop-content-rewards-scraper/run-sync": { "post": { "operationId": "run-sync-citrine_venus-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": "๐Ÿ“ก Campaign status", "enum": [ "active", "completed", "all" ], "type": "string", "description": "๐ŸŽฏ Which campaigns to collect. **Live** = currently paying out. **Ended** = the historical archive (what rates actually cleared). **Everything** = both, the full record.", "default": "active" }, "startUrls": { "title": "๐Ÿ”— Campaign URLs (optional โ€” bulk supported)", "type": "array", "description": "๐Ÿ“Ž Paste one or more campaign links to collect only those, e.g. `https://contentrewards.com/discover/6b7db90d-412f-4bcc-ab1e-619ab73bfa09`. Bulk input supported โ€” one URL per line, paste a list, or upload a file. Leave empty to take the whole board.", "default": [], "items": { "type": "string" } }, "campaignIds": { "title": "๐Ÿ†” Campaign IDs (optional โ€” bulk supported)", "type": "array", "description": "๐Ÿ”‘ Campaign UUIDs instead of full links โ€” for example `6b7db90d-412f-4bcc-ab1e-619ab73bfa09`. One per line. Combines with the URLs above.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "๐Ÿ“ฌ Max campaigns to return", "minimum": 1, "maximum": 500000, "type": "integer", "description": "๐ŸŽ Upper limit on the campaigns saved to your dataset. Start with 10โ€“25 for a quick sample, raise it for the full board (~490 live, ~1,160 ended).", "default": 1000 }, "campaignTypes": { "title": "๐ŸŽฌ Campaign type", "type": "array", "description": "๐ŸŽฅ Keep only these campaign types. `both` campaigns accept clipping *and* UGC, and always pass.", "items": { "type": "string", "enum": [ "clipping", "ugc", "both" ], "enumTitles": [ "โœ‚๏ธ Clipping", "๐ŸŽจ UGC", "๐Ÿ”€ Both" ] }, "default": [] }, "categories": { "title": "๐Ÿท๏ธ Categories", "type": "array", "description": "๐Ÿ“š Keep only these categories. Anything the board is not using right now is named in the log instead of silently returning nothing.", "items": { "type": "string", "enum": [ "Entertainment", "Gaming", "Music", "Personal Brand", "Product", "Technology", "education", "Logo", "Slideshow", "Other" ], "enumTitles": [ "๐Ÿฟ Entertainment", "๐ŸŽฎ Gaming", "๐ŸŽต Music", "๐Ÿง‘โ€๐ŸŽค Personal Brand", "๐Ÿ“ฆ Product", "๐Ÿ’ป Technology", "๐ŸŽ“ Education", "๐Ÿ–ผ๏ธ Logo", "๐Ÿ–ฅ๏ธ Slideshow", "๐Ÿ—‚๏ธ Other" ] }, "default": [] }, "platforms": { "title": "๐Ÿ“ฑ Social platforms", "type": "array", "description": "๐Ÿ“ฒ Keep only campaigns that accept at least one of these platforms.", "items": { "type": "string", "enum": [ "tiktok", "instagram", "youtube", "x", "facebook" ], "enumTitles": [ "๐ŸŽต TikTok", "๐Ÿ“ธ Instagram", "โ–ถ๏ธ YouTube", "โœ–๏ธ X / Twitter", "๐Ÿ‘ฅ Facebook" ] }, "default": [] }, "searchText": { "title": "๐Ÿ”Ž Search text", "type": "string", "description": "๐Ÿ” Keep only campaigns whose title, brand, description or category contains this text (case-insensitive). Example: `poker`.", "default": "" }, "minRewardPerThousand": { "title": "๐Ÿ’ต Min reward per 1,000 views (USD)", "minimum": 0, "type": "number", "description": "๐Ÿ’ธ Only campaigns paying at least this much per 1,000 views. Example: `1.5`." }, "maxRewardPerThousand": { "title": "๐Ÿงฎ Max reward per 1,000 views (USD)", "minimum": 0, "type": "number", "description": "๐Ÿ“‰ Upper bound on the headline rate โ€” handy for benchmarking your own campaign against comparable ones." }, "minMaxPayoutUsd": { "title": "๐ŸŽฐ Min payout ceiling per clip (USD)", "minimum": 0, "type": "number", "description": "๐Ÿ… Only campaigns where a single submission can earn at least this much. Example: `100`." }, "minBudgetLeftUsd": { "title": "๐Ÿฆ Min budget left (USD)", "minimum": 0, "type": "number", "description": "๐Ÿ’ณ Only campaigns with at least this much still unspent โ€” the practical signal that your views will still get paid. Example: `5000`." }, "minTotalBudgetUsd": { "title": "๐Ÿณ Min total budget (USD)", "minimum": 0, "type": "number", "description": "๐Ÿ’ผ Only campaigns funded with at least this much in total. Example: `10000`." }, "maxProgressPercentage": { "title": "๐Ÿ“‰ Max budget already spent (%)", "minimum": 0, "maximum": 100, "type": "integer", "description": "โ›ฝ Only campaigns at most this % through their budget. `80` skips nearly-exhausted campaigns." }, "minDaysToDepletion": { "title": "โณ Min days before the budget runs dry", "minimum": 0, "type": "number", "description": "๐Ÿ•ฐ๏ธ Only campaigns whose remaining budget survives at least this many days at the current burn rate. `7` = still alive next week." }, "minCreators": { "title": "๐Ÿ‘ฅ Min creators", "minimum": 0, "type": "integer", "description": "๐Ÿง‘โ€๐Ÿคโ€๐Ÿง‘ Only campaigns that already have at least this many creators โ€” a proven-payout signal." }, "maxCreators": { "title": "๐ŸงŠ Max creators (skip saturated campaigns)", "minimum": 0, "type": "integer", "description": "๐Ÿšฆ Only campaigns with at most this many creators competing. `300` is a sensible ceiling for a solo clipper." }, "minApprovalRatePct": { "title": "โœ… Min approval rate (%)", "minimum": 0, "maximum": 100, "type": "integer", "description": "๐ŸŽซ Only campaigns that accept at least this share of submissions. `40` skips brands that reject almost everyone." }, "minTotalViews": { "title": "๐Ÿ‘๏ธ Min total views", "minimum": 0, "type": "integer", "description": "๐Ÿ“ˆ Only campaigns that have already accumulated at least this many views. Example: `1000000`." }, "verifiedBrandsOnly": { "title": "๐Ÿ›ก๏ธ Verified brands only", "type": "boolean", "description": "โœ”๏ธ Keep only campaigns run by a verified company.", "default": false }, "minBrandRating": { "title": "โญ Min brand rating (out of 5)", "minimum": 0, "maximum": 5, "type": "number", "description": "๐ŸŒŸ Only brands rated at least this highly by their published reviews. Example: `4.5`." }, "minBrandMembers": { "title": "๐Ÿข Min brand member count", "minimum": 0, "type": "integer", "description": "๐Ÿ‘จโ€๐Ÿ‘ฉโ€๐Ÿ‘งโ€๐Ÿ‘ฆ Only brands with at least this many members โ€” a size and legitimacy signal." }, "hasResourcesOnly": { "title": "๐Ÿ“Ž Only campaigns with a brief / footage bank", "type": "boolean", "description": "๐Ÿ—‚๏ธ Keep only campaigns that publish brief, footage or asset links you can actually work from.", "default": false }, "fundedAfter": { "title": "๐Ÿ“… Funded after", "type": "string", "description": "๐Ÿ—“๏ธ Only campaigns funded on or after this date.", "default": "" }, "fundedBefore": { "title": "๐Ÿ“† Funded before", "type": "string", "description": "๐Ÿ—“๏ธ Only campaigns funded on or before this date.", "default": "" }, "newSince": { "title": "๐Ÿšจ Launch alert โ€” only campaigns newer than", "type": "string", "description": "โฐ ISO timestamp, e.g. `2026-07-25T00:00:00Z`. Combined with a schedule this turns the run into a launch alert instead of a re-scrape.", "default": "" }, "sortBy": { "title": "๐Ÿ”ฝ Sort results by", "enum": [ "budgetLeft", "reward", "opportunity", "newest", "oldest", "progress", "leastCreators", "creators", "approvalRate", "totalViews", "burnRate", "daysLeft", "totalBudget" ], "type": "string", "description": "๐Ÿ“Š Order of the campaigns in your dataset.", "default": "budgetLeft" }, "includeDetails": { "title": "๐Ÿ’Ž Deep campaign read", "type": "boolean", "description": "๐Ÿ”ฌ Open every campaign for its **per-platform payout table**, requirements, brief links, approval rate, top earners and the **real creator count**. Turning this off is much cheaper but returns creators and success rate as the board's placeholder `0`.", "default": true }, "includeBrand": { "title": "๐Ÿ›ก๏ธ Brand trust layer", "type": "boolean", "description": "๐Ÿข Add whether the brand is verified, its rating, review count, member count and how long it has been around.", "default": true }, "includeViewHistory": { "title": "๐Ÿ“ˆ Daily view history", "type": "boolean", "description": "๐Ÿ“Š Add the day-by-day view series and the last-7-day total for each campaign (one extra lookup per campaign).", "default": false }, "includeDescription": { "title": "๐Ÿ“ Campaign description", "type": "boolean", "description": "๐Ÿ“„ Include the full campaign brief text.", "default": true }, "includeRaw": { "title": "๐Ÿงพ Original display strings", "type": "boolean", "description": "๐Ÿ”ค Add a `raw` object with the values exactly as the site renders them, next to the parsed numbers.", "default": false }, "proxyConfiguration": { "title": "๐ŸŒ Proxy configuration", "type": "object", "description": "๐Ÿšฆ By default the run starts on a **direct connection** and automatically switches to a **datacenter** and then a **residential** route only if the site pushes back โ€” then stays there for the rest of the run. Every switch is logged. Pick your own route here to override that.", "default": { "useApifyProxy": false } }, "concurrency": { "title": "โšก Campaigns in parallel", "minimum": 1, "maximum": 20, "type": "integer", "description": "๐ŸŽ๏ธ How many campaigns to read at the same time. Lower it to 4 if a slow proxy starts pushing back.", "default": 8 }, "requestDelaySeconds": { "title": "๐Ÿข Delay between requests (seconds)", "minimum": 0, "maximum": 10, "type": "number", "description": "๐Ÿ•ฐ๏ธ A small pause keeps the run extra polite. `0` is fine for this target.", "default": 0 }, "maxRetries": { "title": "๐Ÿ” Retries per request", "minimum": 1, "maximum": 10, "type": "integer", "description": "๐Ÿ›ก๏ธ Attempts before the run switches to the next network route.", "default": 3 }, "maxScanned": { "title": "๐Ÿ”ฌ Max rows scanned", "minimum": 1, "maximum": 100000, "type": "integer", "description": "๐Ÿงฏ Safety cap on how many board rows are examined before the filters give up. Raise it only for very large archives.", "default": 20000 } } }, "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 } } } } } } } } } }