{
  "openapi": "3.0.1",
  "info": {
    "title": "ClickBank Marketplace Scraper",
    "description": "Scrape ClickBank Marketplace affiliate offers: gravity, avg $/sale, EPC, conversion rate, refund rate, rebill, category, vendor and affiliate page. Filter by keyword, category and stats. Export JSON, CSV, Excel or use the API.",
    "version": "1.0",
    "x-build-id": "fe8Kjcrjef5eiJLHL"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/parsebird~clickbank-marketplace-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-parsebird-clickbank-marketplace-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~clickbank-marketplace-scraper/runs": {
      "post": {
        "operationId": "runs-sync-parsebird-clickbank-marketplace-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~clickbank-marketplace-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-parsebird-clickbank-marketplace-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": {
          "keyword": {
            "title": "Keyword",
            "type": "string",
            "description": "Enter words to search offer titles and descriptions, as in the ClickBank Marketplace search box. Put a phrase in double quotes for an exact match, or combine words with AND, OR and NOT. Leave empty to list every offer.",
            "default": ""
          },
          "category": {
            "title": "Category",
            "enum": [
              "Arts & Entertainment",
              "As Seen on TV",
              "Betting Systems",
              "Business / Investing",
              "Computers / Internet",
              "Cooking, Food & Wine",
              "E-business & E-marketing",
              "E-Commerce",
              "Education",
              "Employment & Jobs",
              "Fiction",
              "Games",
              "Green Products",
              "Health & Fitness",
              "Home & Garden",
              "Languages",
              "Mobile",
              "Parenting & Families",
              "Politics / Current Events",
              "Reference",
              "Self-Help",
              "Software & Services",
              "Spirituality, New Age & Alternative Beliefs",
              "Sports",
              "Travel"
            ],
            "type": "string",
            "description": "Choose a ClickBank Marketplace category. Leave empty to search all categories."
          },
          "subCategory": {
            "title": "Sub-category",
            "type": "string",
            "description": "Enter a sub-category exactly as ClickBank shows it, such as 'Diets & Weight Loss' or 'Dietary Supplements'. Capitals and punctuation don't matter. Works with or without a category.",
            "default": ""
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "gravity",
              "biGravity",
              "rank",
              "relevance",
              "popularity",
              "averageEarningsPerSale",
              "initialEarningsPerSale",
              "averageEPC",
              "initialEPC",
              "futureEPC",
              "netEPC",
              "conversionRate"
            ],
            "type": "string",
            "description": "Choose how ClickBank orders the offers. With a limit on results, this decides which offers you get. 'Keyword relevance' needs a keyword; without one, offers come in ClickBank rank order.",
            "default": "gravity"
          },
          "sortDescending": {
            "title": "Highest first",
            "type": "boolean",
            "description": "Turn on to put the highest values first, or the best rank first when sorting by rank. Turn off for lowest first.",
            "default": true
          },
          "maxResults": {
            "title": "Max results",
            "minimum": 1,
            "type": "integer",
            "description": "Set the most offers to save. The whole ClickBank Marketplace has about 1,200 offers.",
            "default": 50
          },
          "offerTypes": {
            "title": "Offer types",
            "type": "array",
            "description": "Choose offer types to include. When you pick more than one, an offer must match all of them.",
            "items": {
              "type": "string",
              "enum": [
                "standard",
                "rebill",
                "dollar_trial",
                "shippable",
                "upsell"
              ],
              "enumTitles": [
                "One-time",
                "Recurring (rebill)",
                "$1 trial",
                "Physical product",
                "Has upsells"
              ]
            }
          },
          "languages": {
            "title": "Languages",
            "type": "array",
            "description": "Choose the sales page languages to include. When you pick more than one, an offer must be available in all of them.",
            "items": {
              "type": "string",
              "enum": [
                "en",
                "de",
                "es",
                "fr",
                "it",
                "pt"
              ],
              "enumTitles": [
                "English",
                "German",
                "Spanish",
                "French",
                "Italian",
                "Portuguese"
              ]
            }
          },
          "activatedAfter": {
            "title": "Activated after",
            "type": "string",
            "description": "Only include offers that joined the marketplace on or after this date. Use a date or a period like '30 days' to find new offers."
          },
          "activatedBefore": {
            "title": "Activated before",
            "type": "string",
            "description": "Only include offers that joined the marketplace on or before this date."
          },
          "mobileEnabled": {
            "title": "Mobile optimized only",
            "type": "boolean",
            "description": "Turn on to include only offers ClickBank marks as mobile enabled.",
            "default": false
          },
          "cpaVisible": {
            "title": "CPA offers only",
            "type": "boolean",
            "description": "Turn on to include only offers with a visible CPA (cost per action) program.",
            "default": false
          },
          "directTracking": {
            "title": "Direct link tracking only",
            "type": "boolean",
            "description": "Turn on to include only offers that allow direct linking to the sales page without a redirect.",
            "default": false
          },
          "affiliatePage": {
            "title": "Has affiliate page only",
            "type": "boolean",
            "description": "Turn on to include only offers that have an affiliate tools page.",
            "default": false
          },
          "multipleHoplinks": {
            "title": "Multiple hoplinks only",
            "type": "boolean",
            "description": "Turn on to include only offers with more than one hoplink target page.",
            "default": false
          },
          "noSellerApproval": {
            "title": "No seller approval needed",
            "type": "boolean",
            "description": "Turn on to include only offers you can promote without asking the seller for approval.",
            "default": false
          },
          "minGravity": {
            "title": "Min gravity",
            "minimum": 0,
            "type": "number",
            "description": "Enter the lowest gravity score to include, such as 10."
          },
          "maxGravity": {
            "title": "Max gravity",
            "minimum": 0,
            "type": "number",
            "description": "Enter the highest gravity score to include. Useful for finding less crowded offers."
          },
          "minAverageEarningsPerSale": {
            "title": "Min avg $/sale",
            "minimum": 0,
            "type": "number",
            "description": "Enter the lowest average affiliate earnings per sale in US dollars, such as 50."
          },
          "minInitialEarningsPerSale": {
            "title": "Min initial $/sale",
            "minimum": 0,
            "type": "number",
            "description": "Enter the lowest initial affiliate earnings per sale in US dollars."
          },
          "minNetEPC": {
            "title": "Min EPC",
            "minimum": 0,
            "type": "number",
            "description": "Enter the lowest average earnings per click in US dollars, such as 0.5."
          },
          "minConversionRate": {
            "title": "Min conversion rate (%)",
            "minimum": 0,
            "type": "number",
            "description": "Enter the lowest conversion rate in percent, such as 1 for 1%."
          },
          "affiliateNickname": {
            "title": "Affiliate nickname",
            "type": "string",
            "description": "Enter your ClickBank affiliate nickname to add a ready-made hoplink to each offer. Your nickname is used only to build the links."
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "The scraper connects to ClickBank directly and switches to Apify Proxy on its own if it gets blocked. Set a proxy here only if you want every request to go through it.",
            "default": {
              "useApifyProxy": false
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}