{
  "openapi": "3.0.1",
  "info": {
    "title": "Gumroad Scraper - Products, Creators & Sales",
    "description": "Scrape Gumroad digital products by keyword, niche or URL: prices, ratings, sales counts, product types, tiers & full descriptions. Get deduplicated creator/seller leads with bio, socials & emails, plus a new-product & price-drop monitor. Export JSON, CSV, Excel.",
    "version": "0.1",
    "x-build-id": "w5f1BCLF3eVCRjy1p"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapesage~gumroad-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapesage-gumroad-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/scrapesage~gumroad-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapesage-gumroad-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/scrapesage~gumroad-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapesage-gumroad-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": {
          "searchQueries": {
            "title": "Search queries",
            "type": "array",
            "description": "Keywords to search Gumroad Discover, e.g. <code>notion template</code>, <code>stable diffusion</code>, <code>trading course</code>. Each query is combined with every tag below (or run on its own).",
            "items": {
              "type": "string"
            }
          },
          "tags": {
            "title": "Tags / niches",
            "type": "array",
            "description": "Gumroad tags or category niches to browse — works on their own or to narrow a search query. Examples: <code>notion</code>, <code>fitness</code>, <code>3d</code>, <code>stable-diffusion</code>, <code>design</code>, <code>productivity</code>, <code>ebook</code>, <code>lightroom-presets</code>.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Start URLs",
            "type": "array",
            "description": "Direct Gumroad URLs (used in addition to searches): product pages (<code>https://creator.gumroad.com/l/permalink</code>), creator profiles (<code>https://creator.gumroad.com/</code>), or Discover/search pages (<code>https://gumroad.com/discover?query=...</code>). Auto-routed.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "sort": {
            "title": "Sort by",
            "enum": [
              "recommended",
              "staff_picked",
              "best_selling",
              "most_reviewed",
              "highest_rated",
              "newest",
              "trending",
              "price_low_to_high",
              "price_high_to_low"
            ],
            "type": "string",
            "description": "Ordering of search/discover results.",
            "default": "recommended"
          },
          "productType": {
            "title": "Product types",
            "type": "array",
            "description": "Only keep products of these types (leave empty for all). Common values: <code>digital</code>, <code>course</code>, <code>ebook</code>, <code>membership</code>, <code>bundle</code>, <code>physical</code>, <code>audiobook</code>, <code>podcast</code>, <code>commission</code>, <code>call</code>.",
            "items": {
              "type": "string"
            }
          },
          "fileTypes": {
            "title": "File types",
            "type": "array",
            "description": "Only include products that ship these file types (server-side filter). Examples: <code>pdf</code>, <code>mp4</code>, <code>zip</code>, <code>mp3</code>, <code>epub</code>, <code>docx</code>, <code>png</code>.",
            "items": {
              "type": "string"
            }
          },
          "minPrice": {
            "title": "Min price (USD)",
            "minimum": 0,
            "type": "integer",
            "description": "Only include products priced at or above this amount (USD)."
          },
          "maxPrice": {
            "title": "Max price (USD)",
            "minimum": 0,
            "type": "integer",
            "description": "Only include products priced at or below this amount (USD)."
          },
          "minRating": {
            "title": "Min rating",
            "minimum": 0,
            "maximum": 5,
            "type": "integer",
            "description": "Only include products with an average rating at or above this value (0–5)."
          },
          "freeOnly": {
            "title": "Free / pay-what-you-want only",
            "type": "boolean",
            "description": "Only include free or pay-what-you-want products.",
            "default": false
          },
          "maxResults": {
            "title": "Max products",
            "minimum": 1,
            "type": "integer",
            "description": "Maximum number of products to scrape across all queries and tags.",
            "default": 100
          },
          "includeProductDetails": {
            "title": "Include full product details",
            "type": "boolean",
            "description": "Fetch each product's detail JSON for the richest data: sales count, full rating histogram (1–5 stars), full HTML description, variants/tiers, membership pricing, attributes, cover images, refund policy and created/updated dates. One extra fast JSON call per product. Turn off for cheap discovery (cards still include price, rating, seller and type).",
            "default": true
          },
          "includeCreatorLeads": {
            "title": "Emit creator / seller leads",
            "type": "boolean",
            "description": "In addition to products, push one deduplicated creator record per unique seller (type = \"creator\") with bio, Twitter/X, product count, run-level sales/ratings, a 0–100 lead score, and optional website + email enrichment.",
            "default": true
          },
          "enrichCreatorEmails": {
            "title": "Enrich creator emails from their website",
            "type": "boolean",
            "description": "For creators that link an external website (in their bio or via a custom domain), crawl up to 3 pages (home + contact/about) for contact emails, phone numbers and extra social links. Gumroad never exposes emails directly — this is the only way to get them.",
            "default": false
          },
          "monitorMode": {
            "title": "Monitor mode (only new / changed)",
            "type": "boolean",
            "description": "Remember products and creators between runs (in a named key-value store) and emit ONLY new or changed records — new products, price drops/rises, new sales, new ratings. Pairs perfectly with Apify Schedules: the Schedule decides WHEN to run, monitor mode decides WHAT is new. It does not conflict with scheduling.",
            "default": false
          },
          "monitorKey": {
            "title": "Monitor key",
            "type": "string",
            "description": "Name for this monitor's memory. Use a distinct key per saved search/niche so they don't share state (e.g. <code>notion-templates</code>, <code>ai-art</code>).",
            "default": "default"
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 30,
            "type": "integer",
            "description": "Maximum parallel requests.",
            "default": 8
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Proxies to use. The default Apify Proxy works well — Gumroad's public endpoints are clean, and rotating IPs avoids per-IP rate limits. Residential proxies are an optional fallback.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}