{
  "openapi": "3.0.1",
  "info": {
    "title": "Vivino Scraper: Wine Prices, Ratings & Reviews",
    "description": "Scrape Vivino wines in 21 markets: ratings, prices and shops, taste profile, grapes, food pairings, rankings, critic scores and reviews. Filter by type, country, grape, region, style, rating and price, search by name or paste links. Price watch mode alerts you to price drops.",
    "version": "1.0",
    "x-build-id": "DaBLE0hIdFackgtdW"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/trev0n~vivino-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-trev0n-vivino-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/trev0n~vivino-scraper/runs": {
      "post": {
        "operationId": "runs-sync-trev0n-vivino-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/trev0n~vivino-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-trev0n-vivino-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": {
          "market": {
            "title": "🌍 Market",
            "enum": [
              "US",
              "GB",
              "DE",
              "FR",
              "IT",
              "ES",
              "NL",
              "BE",
              "AT",
              "CH",
              "DK",
              "SE",
              "FI",
              "PT",
              "CA",
              "AU",
              "SG",
              "HK",
              "JP",
              "BR"
            ],
            "type": "string",
            "description": "The country whose shops, prices and currency you want. Vivino shows different shops and prices in every market.",
            "default": "US"
          },
          "searchTerms": {
            "title": "🔎 Wine names",
            "type": "array",
            "description": "Search wines by name, e.g. \"Opus One\", \"Chateau Margaux\", \"Barolo\". Each name is one search; the filters below also apply. A wine no shop sells in your market is still found, without a price.",
            "items": {
              "type": "string"
            }
          },
          "wineTypes": {
            "title": "🍷 Wine types",
            "type": "array",
            "description": "Only these wine types. Empty = all types.",
            "items": {
              "type": "string",
              "enum": [
                "red",
                "white",
                "sparkling",
                "rose",
                "dessert",
                "fortified"
              ],
              "enumTitles": [
                "Red",
                "White",
                "Sparkling",
                "Rosé",
                "Dessert",
                "Fortified"
              ]
            }
          },
          "wineCountries": {
            "title": "🗺️ Wine from (countries)",
            "type": "array",
            "description": "Countries the wine comes from: a name or a two-letter code, e.g. \"France\", \"it\", \"Spain\".",
            "items": {
              "type": "string"
            }
          },
          "grapes": {
            "title": "🍇 Grapes",
            "type": "array",
            "description": "Grape varieties as Vivino names them, e.g. \"Cabernet Sauvignon\", \"Pinot Noir\", \"Syrah\".",
            "items": {
              "type": "string"
            }
          },
          "regions": {
            "title": "📍 Wine regions",
            "type": "array",
            "description": "Wine regions, e.g. \"Napa Valley\", \"Bordeaux\", \"Rioja\", \"Barolo\".",
            "items": {
              "type": "string"
            }
          },
          "wineStyles": {
            "title": "🎨 Wine styles",
            "type": "array",
            "description": "Vivino wine styles, e.g. \"Napa Valley Cabernet Sauvignon\", \"Spanish Rioja Red\", \"Italian Barolo\".",
            "items": {
              "type": "string"
            }
          },
          "foodPairings": {
            "title": "🧀 Goes well with",
            "type": "array",
            "description": "Food pairings, e.g. \"Beef\", \"Lamb\", \"Shellfish\", \"Pasta\", \"Spicy food\", \"Mature and hard cheese\".",
            "items": {
              "type": "string"
            }
          },
          "minRating": {
            "title": "⭐ Minimum rating",
            "enum": [
              "1",
              "3",
              "3.5",
              "3.8",
              "4",
              "4.2",
              "4.5"
            ],
            "type": "string",
            "description": "Only wines with at least this average rating (1–5).",
            "default": "1"
          },
          "minRatingsCount": {
            "title": "👥 Minimum number of ratings",
            "minimum": 0,
            "type": "integer",
            "description": "Skip wines rated by fewer people, e.g. 100 for well-known wines only. 0 = no limit.",
            "default": 0
          },
          "priceMin": {
            "title": "💲 Minimum price",
            "minimum": 0,
            "type": "integer",
            "description": "Lowest bottle price, in the market's currency."
          },
          "priceMax": {
            "title": "💲 Maximum price",
            "minimum": 0,
            "type": "integer",
            "description": "Highest bottle price, in the market's currency."
          },
          "vintageYears": {
            "title": "📅 Vintages",
            "type": "array",
            "description": "Only these years, e.g. \"2018\", \"2019\".",
            "items": {
              "type": "string"
            }
          },
          "sortBy": {
            "title": "↕️ Sort by",
            "enum": [
              "bestPicks",
              "highestRated",
              "mostRated",
              "priceLowToHigh",
              "priceHighToLow",
              "biggestDiscount",
              "relevance"
            ],
            "type": "string",
            "description": "The order wines come in. It decides which wines you get when you set a result limit.",
            "default": "bestPicks"
          },
          "startUrls": {
            "title": "🔗 Vivino links",
            "type": "array",
            "description": "Paste Vivino pages: a wine (vivino.com/.../w/1911534?year=2018), an Explore page with your filters, a search, a winery (vivino.com/wineries/opus-one), a region, grape or wine style page.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "maxResultsPerSearch": {
            "title": "🔢 Max wines per search",
            "minimum": 0,
            "type": "integer",
            "description": "How many wines each name, link or filter search may return. 0 = everything Vivino has.",
            "default": 100
          },
          "splitLargeSearches": {
            "title": "✂️ Go past Vivino's 2,000 limit",
            "type": "boolean",
            "description": "Vivino lists at most 2,000 wines per search. When you want more, the search is split into price bands (and wine types) automatically.",
            "default": true
          },
          "includeDetails": {
            "title": "📖 Full wine details",
            "type": "boolean",
            "description": "Adds description, alcohol, grapes and blend, food pairings, drinking window, rankings (world, country, region, winery), critic scores, awards, top lists and every shop offer. Charged per wine with details.",
            "default": false
          },
          "includeReviews": {
            "title": "💬 Reviews",
            "type": "boolean",
            "description": "Adds community reviews (rating, text, language, date, likes) to each wine. Charged per review.",
            "default": false
          },
          "maxReviewsPerWine": {
            "title": "💬 Max reviews per wine",
            "minimum": 0,
            "type": "integer",
            "description": "How many reviews per wine. 0 = all of them.",
            "default": 20
          },
          "maxConcurrency": {
            "title": "⚡ Parallel requests",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "How many requests run at the same time.",
            "default": 4
          },
          "compact": {
            "title": "📋 Compact output",
            "type": "boolean",
            "description": "Only the key columns: name, winery, year, type, region, country, rating, price, link.",
            "default": false
          },
          "excludeEmptyFields": {
            "title": "🧹 Hide empty fields",
            "type": "boolean",
            "description": "Leave out fields with no value.",
            "default": false
          },
          "incrementalMode": {
            "title": "🔁 Price watch (only new wines and price changes)",
            "type": "boolean",
            "description": "Remember the wines and prices from earlier runs and return only new wines, price changes (with the old price and the change in %) and wines back in stock. Schedule it daily and pay only for what changed.",
            "default": false
          },
          "stateKey": {
            "title": "🗝️ Watch name",
            "type": "string",
            "description": "Optional name for this watch, so several watches keep separate memories. Empty = derived from your search."
          },
          "emitUnchanged": {
            "title": "Return unchanged wines too",
            "type": "boolean",
            "description": "In price watch, also return wines whose price did not change.",
            "default": false
          },
          "emitExpired": {
            "title": "Return wines no longer listed",
            "type": "boolean",
            "description": "In price watch, also return wines that dropped out of the results since the last run.",
            "default": false
          },
          "webhookUrl": {
            "title": "🌐 Webhook URL",
            "type": "string",
            "description": "POST a JSON summary of new wines and price changes here after each run."
          },
          "telegramBotToken": {
            "title": "Telegram bot token",
            "type": "string",
            "description": "Telegram bot token for alerts."
          },
          "telegramChatId": {
            "title": "Telegram chat ID",
            "type": "string",
            "description": "Telegram chat that receives the alerts."
          },
          "discordWebhookUrl": {
            "title": "Discord webhook URL",
            "type": "string",
            "description": "Discord channel webhook for alerts."
          },
          "slackWebhookUrl": {
            "title": "Slack webhook URL",
            "type": "string",
            "description": "Slack incoming webhook for alerts."
          },
          "notifyOnlyChanges": {
            "title": "Alert only when something changed",
            "type": "boolean",
            "description": "Skip the alert when a run finds nothing new.",
            "default": true
          },
          "notificationLimit": {
            "title": "Wines per alert",
            "minimum": 1,
            "type": "integer",
            "description": "How many wines one alert lists (price drops first).",
            "default": 10
          },
          "includeRunSummary": {
            "title": "Add run summary to webhook",
            "type": "boolean",
            "description": "Include the run summary in the webhook JSON.",
            "default": true
          },
          "proxyFallback": {
            "title": "Switch to proxies when blocked",
            "type": "boolean",
            "description": "If Vivino starts refusing requests, continue the run through Apify Proxy.",
            "default": true
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Not needed: Vivino answers without a proxy. Turn on only if your runs get blocked.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}