{
  "openapi": "3.0.1",
  "info": {
    "title": "Whop Reviews Scraper API",
    "description": "Scrape every public Whop review at scale. Filter by stars, date, keyword, reviewer. Rank oldest or by rating. Enrich with company, product, reviewer, and attachment details on demand.",
    "version": "0.0",
    "x-build-id": "fhoWmM7w4Bdqjgcc9"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/lurkapi~whop-reviews-scraper-api/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-lurkapi-whop-reviews-scraper-api",
        "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/lurkapi~whop-reviews-scraper-api/runs": {
      "post": {
        "operationId": "runs-sync-lurkapi-whop-reviews-scraper-api",
        "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/lurkapi~whop-reviews-scraper-api/run-sync": {
      "post": {
        "operationId": "run-sync-lurkapi-whop-reviews-scraper-api",
        "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": [
          "startUrls"
        ],
        "properties": {
          "startUrls": {
            "title": "Whop company or product URLs",
            "minItems": 1,
            "maxItems": 100,
            "type": "array",
            "description": "Direct public Whop company or product URLs, one per line.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "title": "URL",
                  "description": "Direct public Whop company or product URL.",
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 2000
                }
              }
            }
          },
          "maxReviewsPerCompany": {
            "title": "Maximum reviews per company",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "How many reviews to return for each resolved company. Run-wide safety cap is 50,000 reviews.",
            "default": 100
          },
          "ratings": {
            "title": "Star ratings ($)",
            "maxItems": 5,
            "uniqueItems": true,
            "type": "array",
            "description": "Keep reviews with any selected star rating. Multiple stars inside this filter still count as one filter.",
            "items": {
              "type": "string",
              "enum": [
                "1",
                "2",
                "3",
                "4",
                "5"
              ],
              "enumTitles": [
                "1 star",
                "2 stars",
                "3 stars",
                "4 stars",
                "5 stars"
              ]
            },
            "default": []
          },
          "publishedAfter": {
            "title": "Published on or after ($)",
            "type": "string",
            "description": "Earliest review publication date, inclusive. Setting either date bound activates one paid date filter."
          },
          "publishedBefore": {
            "title": "Published on or before ($)",
            "type": "string",
            "description": "Latest review publication date, inclusive."
          },
          "searchText": {
            "title": "Review text contains ($)",
            "maxLength": 200,
            "type": "string",
            "description": "Case-insensitive match against the public review title and body."
          },
          "paidForProduct": {
            "title": "Paid for product ($)",
            "enum": [
              "any",
              "yes",
              "no"
            ],
            "type": "string",
            "description": "Keep all reviews, only reviews marked as paid for a product, or only reviews not marked that way.",
            "default": "any"
          },
          "hasAttachments": {
            "title": "Has attachments ($)",
            "enum": [
              "any",
              "yes",
              "no"
            ],
            "type": "string",
            "description": "Keep all reviews, only reviews with public attachments, or only reviews without attachments.",
            "default": "any"
          },
          "reviewerSearch": {
            "title": "Reviewer contains ($)",
            "maxLength": 100,
            "type": "string",
            "description": "Case-insensitive match against the public reviewer display name or username."
          },
          "sortBy": {
            "title": "Sort reviews",
            "enum": [
              "source",
              "oldest",
              "highestRating",
              "lowestRating"
            ],
            "type": "string",
            "description": "Source / newest order is free. Any other sort costs one sorting event per emitted review.",
            "default": "source"
          },
          "includeCompanyDetails": {
            "title": "Company details ($)",
            "type": "boolean",
            "description": "Adds public company verification, member count, aggregate review metrics, industry, creation date, and logo. Charged only for rows where enrichment succeeded.",
            "default": false
          },
          "includeProductDetails": {
            "title": "Requested product details ($)",
            "type": "boolean",
            "description": "For product URL inputs, adds public product identity, category, pricing, and marketplace metrics. Reviews stay company-scoped. Charged only for rows where enrichment succeeded.",
            "default": false
          },
          "includeReviewerDetails": {
            "title": "Reviewer profile details ($)",
            "type": "boolean",
            "description": "Adds public reviewer ID, account and membership timestamps, and profile image. Charged only for rows where reviewer details were available.",
            "default": false
          },
          "includeAttachments": {
            "title": "Review attachments ($)",
            "type": "boolean",
            "description": "Adds public attachment IDs, file metadata, and URLs. Charged only for rows containing at least one attachment with a usable URL.",
            "default": false
          },
          "outputReviewTitle": {
            "title": "Output: review title",
            "type": "boolean",
            "description": "Include the optional public review title.",
            "default": true
          },
          "outputCreatedAt": {
            "title": "Output: created date",
            "type": "boolean",
            "description": "Include when the review was originally created.",
            "default": true
          },
          "outputPublishedAt": {
            "title": "Output: published date",
            "type": "boolean",
            "description": "Include when the review was publicly published.",
            "default": true
          },
          "outputPaidForProduct": {
            "title": "Output: paid-for-product indicator",
            "type": "boolean",
            "description": "Include the public paid-for-product indicator when available.",
            "default": true
          },
          "outputReviewStatus": {
            "title": "Output: source review status",
            "type": "boolean",
            "description": "Include the review's public source status.",
            "default": true
          },
          "outputReviewerName": {
            "title": "Output: reviewer name",
            "type": "boolean",
            "description": "Include the public reviewer display name.",
            "default": true
          },
          "outputReviewerUsername": {
            "title": "Output: reviewer username",
            "type": "boolean",
            "description": "Include the public reviewer username.",
            "default": true
          },
          "outputJoinedAt": {
            "title": "Output: reviewer joined date",
            "type": "boolean",
            "description": "Include when the reviewer joined the company or product (public purchase timestamp).",
            "default": true
          },
          "outputMembershipDuration": {
            "title": "Output: days as member at review",
            "type": "boolean",
            "description": "Include the integer number of days between the reviewer's join date and the review's publish date. Whop UI shows this as 'N months after purchase'.",
            "default": 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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}