{ "openapi": "3.0.1", "info": { "title": "Untappd Beer & Brewery Scraper", "description": "Scrape Untappd - search beers or breweries, browse the global top-rated beer list, and fetch full beer or brewery detail (style, ABV, IBU, ratings, description, location) by ID.", "version": "1.0", "x-build-id": "jVKd3mx4zyYdqeMT0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~untappd-beer-brewery-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-untappd-beer-brewery-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/crawlerbros~untappd-beer-brewery-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-untappd-beer-brewery-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/crawlerbros~untappd-beer-brewery-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-untappd-beer-brewery-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "searchBreweries", "topRated", "byBeerIds", "byBreweryIds" ], "type": "string", "description": "What to fetch.", "default": "search" }, "searchQuery": { "title": "Search query (mode=search / searchBreweries)", "type": "string", "description": "Beer or brewery name/keyword to search for.", "default": "ipa" }, "beerIds": { "title": "Beer IDs or URLs (mode=byBeerIds)", "type": "array", "description": "Numeric Untappd beer IDs (e.g. `1`) or beer URLs (e.g. `https://untappd.com/beer/1` or `https://untappd.com/b/magic-hat-brewing-company-hocus-pocus/1`).", "default": [], "items": { "type": "string" } }, "breweryIds": { "title": "Brewery IDs, slugs, or URLs (mode=byBreweryIds)", "type": "array", "description": "Numeric Untappd brewery IDs (e.g. `812`), vanity slugs (e.g. `magichat`), or brewery URLs.", "default": [], "items": { "type": "string" } }, "minRating": { "title": "Minimum rating (0-5)", "minimum": 0, "maximum": 5, "type": "number", "description": "Drop beers with an average rating below this." }, "abvMin": { "title": "Minimum ABV %", "minimum": 0, "maximum": 100, "type": "number", "description": "Drop beers with ABV below this percentage." }, "abvMax": { "title": "Maximum ABV %", "minimum": 0, "maximum": 100, "type": "number", "description": "Drop beers with ABV above this percentage." }, "styleContains": { "title": "Style contains", "type": "string", "description": "Only keep beers whose style text contains this substring (e.g. `IPA`, `Stout`, `Wheat`)." }, "topRatedStyle": { "title": "Beer style (mode=topRated)", "enum": [ "", "Altbier-Doppelsticke", "Altbier-Sticke", "altbier", "australian-sparkling-ale", "barleywine-american", "barleywine-english", "barleywine-other", "belgian-blonde", "belgian-dubbel", "belgian-enkel", "belgian-quad", "belgian-strong-dark-ale", "belgian-strong-golden-ale", "belgian-tripel", "bitter-best", "bitter-extra-special-strong", "bitter-session-ordinary", "biere-de-champagne-biere-brut", "black-tan", "golden-ale-american", "golden-ale-english", "golden-ale-other", "bock-doppelbock", "bock-eisbock", "bock-hell-mailbock-lentebock", "bock-single-traditional", "bock-weizenbock", "bock-weizendoppelbock", "brett-beer", "brown-ale-american", "brown-ale-belgian", "brown-ale-english", "brown-ale-imperial-double", "brown-ale-other", "california-common", "chilli-chile-beer", "Cider-Applewine", "Cider-Basque", "cider-dry", "graff", "cider-herbed-spiced-hopped", "Cider-Hopped", "cider-ice-applewine", "Cider-Keeved-Cidre-Bouché", "Cider-Other", "cider-other-fruit", "cider-perry-poire", "cider-rose", "cider-sweet", "cider-traditional", "corn-beer", "cream-ale", "Cream-Ale-Imperial-Double", "dark-ale", "biere-de-coupage", "biere-de-garde", "biere-de-mars", "Farmhouse-Ale-Brett", "Farmhouse-Ale-Gotlandsdricke", "farmhouse-ale-grisette", "Farmhouse-Ale-Koduõlu", "Farmhouse-Ale-Kornøl", "farmhouse-ale-other", "farmhouse-ale-sahti", "farmhouse-ale-saison", "Farmhouse-Ale-Stjørdalsøl", "Farmhouse-Ale-Vossaøl-Heimabrugg", "festbier", "flavored-malt-beverage", "freeze-distilled-beer", "fruit-beer", "gluten-free", "golden-ale-ukrainian", "italian-grape-ale", "grape-ale-other", "happoshu", "hard-ginger-beer", "hard-kombucha-jun", "hard-seltzer", "historical-beer-adambier", "historical-beer-berliner-braunbier", "historical-beer-broyhan", "historical-beer-burton-ale", "historical-beer-dampfbier", "grodziskie-gratzer", "historical-beer-gruit-ancient-herbed-ale", "historical-beer-kentucky-common", "Historical-Beer-Keptinis", "historical-beer-kottbusser", "historical-beer-kuit-kuyt-koyt", "historical-beer-lichtenhainer", "historical-beer-mumme", "historical-beer-other", "Lager-American-Pre-Prohibition", "roggenbier", "Historical-Beer-Schoeps", "historical-beer-steinbier", "historical-beer-zoigl", "honey-beer", "ipa-american", "IPA-Australian", "ipa-belgian", "ipa-black-cascadian-dark-ale", "ipa-brett", "ipa-brown", "ipa-brut", "ipa-cold", "ipa-english", "ipa-farmhouse", "ipa-fruited", "ipa-imperial-double", "ipa-imperial-double-black", "ipa-imperial-double-milkshake", "ipa-imperial-double-new-england", "ipa-milkshake", "ipa-new-england", "ipa-new-zealand", "ipa-other", "ipa-quadruple", "ipa-red", "ipa-rye", "ipa-session", "IPA-Session-New-England-Hazy", "ipa-sour", "ipa-triple", "ipa-triple-new-england", "ipa-white-wheat", "kellerbier-zwickelbier", "Kellerbier-Zwickelbier-Dunkel", "Kellerbier-Zwickelbier-Kellerpils", "koji-beer", "kvass", "koelsch", "Kölsch-Wiess", "lager-amber-red", "lager-american", "lager-american-amber-red", "lager-american-light", "lager-dark", "lager-dortmunder-export", "Lager-Fruited", "lager-leichtbier", "lager-helles", "lager-ipl-india-pale-lager", "lager-japanese-rice", "lager-mexican", "lager-munich-dunkel", "lager-other", "Lager-Other-Light", "lager-pale", "Lager-Polotmavé-Czech-Amber", "lager-rotbier", "Lager-Smoked", "lager-strong", "Lager-Sv?tlé-Czech-Pale", "Lager-Tmavé-Czech-Dark", "lager-vienna", "lager-winter", "lambic-faro", "lambic-framboise", "lambic-fruit", "lambic-gueuze", "lambic-kriek", "lambic-other", "lambic-traditional", "Makgeolli-Fruited", "Makgeolli-Other", "Makgeolli", "malt-beer", "malt-liquor", "mead-acerglyn-maple-wine", "mead-bochet", "mead-braggot", "mead-cyser", "mead-melomel", "mead-metheglin", "mead-other", "mead-pyment", "mead-session-short", "mead-tradtional", "mild-dark", "mild-light", "mild-other", "Mild-Ruby", "maerzen", "Non-Alcoholic-Bitter", "Non-Alcoholic-Blonde-Golden-Ale", "Non-Alcoholic-Brown-Ale", "Non-Alcoholic-CBD-Beverage", "non-alcoholic-cider-perry", "Non-Alcoholic-Coffee", "Non-Alcoholic-Energy-Drink", "Non-Alcoholic-Farmhouse-Ale", "Non-Alcoholic-Fassbrause", "Non-Alcoholic-Festbier-Märzen", "Non-Alcoholic-Fruit-Beer", "Non-Alcoholic-Functional-Beverage", "Non-Alcoholic-Hop-Water", "non-alcoholic-beer-ipa", "Non-Alcoholic-Kombucha", "non-alcoholic-beer-lager", "Non-Alcoholic-Malt-Energy-Drink", "Non-Alcoholic-Malt-Soda", "Non-Alcoholic-Malta", "non-alcoholic-mead", "non-alcoholic-other", "non-alcoholic-beer-other", "non-alcoholic-beer-pale-ale", "non-alcoholic-beer-porter-stout", "Non-Alcoholic-RTD-Cocktail", "Non-Alcoholic-Red-Ale", "non-alcoholic-beer-shandy-radler", "Non-Alcoholic-Shrub-Drinking-Vinegar", "Non-Alcoholic-Soda-Craft", "Non-Alcoholic-Soda-Mass-Market", "non-alcoholic-beer-sour", "Non-Alcoholic-Sparkling-Water", "Non-Alcoholic-Spirit-Alternative", "Non-Alcoholic-Tea", "non-alcoholic-beer-wheat-beer", "Non-Alcoholic-Wine", "old-ale", "pale-ale-american", "pale-ale-australian", "pale-ale-belgian", "pale-ale-english", "Pale-Ale-Fruited", "pale-ale-milkshake", "pale-ale-new-england", "pale-ale-new-zealand", "pale-ale-other", "pale-ale-xpa", "Pilsner-American", "pilsner-czech-bohemian", "pilsner-german", "pilsner-imperial-double", "pilsner-italian", "pilsner-new-zealand", "pilsner-other", "porter-american", "porter-baltic", "porter-coffee", "porter-english", "porter-imperial-double", "porter-baltic-imperial-double", "porter-imperial-stout", "Porter-India-Export", "porter-other", "Porter-Smoked", "pumpkin-yam-beer", "rauchbier", "Red-Ale–Ambrée", "red-ale-american-amber-red", "red-ale-imperial-double", "red-ale-irish", "red-ale-other", "root-beer", "rye-beer", "rye-wine", "schwarzbier", "scotch-ale-wee-heavy", "scottish-ale", "scottish-export-ale", "shandy-radler", "smoked-beer", "sorghum-millet-beer", "sour-berliner-weisse", "Sour-Catharina", "sour-flanders-oud-bruin", "sour-flanders-red-ale", "sour-fruited", "sout-fruited-berliner-weisse", "sour-gose-fruited", "sour-other", "sour-other-gose", "sour-smoothie", "Sour-Tomato-Vegetable-Gose", "sour-gose-traditional", "specialty-grain", "spiced-herbed-beer", "stout-american", "stout-belgian", "stout-coffee", "stout-english", "stout-foreign-export", "stout-imperial-double", "stout-imperial-stout", "stout-imperial-double-milk", "stout-imperial-double-oatmeal", "stout-imperial-pastry", "stout-imperial-double-white-golden", "stout-irish-dry", "stout-milk-sweet", "stout-oatmeal", "stout-other", "stout-oyster", "stout-pastry", "stout-russian-imperial", "Stout–Smoked", "stout-white-golden", "strong-ale-american", "strong-ale-english", "strong-ale-other", "table-beer", "traditional-ale", "wheat-beer-american-pale-wheat", "wheat-beer-dunkelweizen", "Wheat-Beer-Fruited", "wheat-beer-hefeweizen", "wheat-beer-hefeweizen-light", "wheat-beer-hopfenweisse", "wheat-beer-kristallweizen", "wheat-beer-other", "wheat-wine", "wheat-beer-witbier", "wild-ale-american", "wild-ale-other", "winter-ale", "winter-warmer" ], "type": "string", "description": "Scope the top-rated list to a single beer style, using Untappd's own style taxonomy. Leave blank for all styles.", "default": "" }, "topRatedCountry": { "title": "Country (mode=topRated)", "enum": [ "", "afghanistan", "aland-islands", "albania", "algeria", "american-samoa", "andorra", "angola", "anguilla", "antigua-and-barbuda", "argentina", "armenia", "aruba", "australia", "austria", "azerbaijan", "bahamas", "bangladesh", "barbados", "belarus", "belgium", "belize", "benin", "bermuda", "bhutan", "bolivia", "bonaire", "bosnia-and-herzegovina", "botswana", "brazil", "british-virgin-islands", "brunei", "bulgaria", "burkina-faso", "burundi", "cambodia", "cameroon", "canada", "cape-verde", "cayman-islands", "central-african-republic", "chad", "channel-islands-guernsey", "channel-islands-jersey", "chile", "china-people-s-republic-of-china", "colombia", "cook-islands", "costa-rica", "croatia", "cuba", "curacao", "cyprus", "czech-republic", "democratic-republic-of-the-congo", "denmark", "dominica", "dominican-republic", "east-timor", "ecuador", "egypt", "el-salvador", "england", "equatorial-guinea", "eritrea", "estonia", "eswatini", "ethiopia", "falkland-islands", "faroe-islands", "fiji", "finland", "france", "french-polynesia", "gabon", "gambia", "georgia", "germany", "ghana", "gibraltar", "greece", "greenland", "grenada", "guam", "guatemala", "guinea", "guinea-bissau", "guyana", "haiti", "honduras", "hong-kong", "hungary", "iceland", "india", "indonesia", "iran", "iraq", "ireland", "isle-of-man", "israel", "italy", "ivory-coast", "jamaica", "japan", "jordan", "kazakhstan", "kenya", "kosovo", "kuwait", "kyrgyzstan", "laos", "latvia", "lebanon", "lesotho", "liberia", "libya", "liechtenstein", "lithuania", "luxembourg", "macau", "madagascar", "malawi", "malaysia", "mali", "malta", "marshall-islands", "mauritius", "mexico", "micronesia", "moldova", "mongolia", "montenegro", "montserrat", "morocco", "mozambique", "myanmar-burma", "namibia", "nepal", "netherlands", "new-caledonia", "new-zealand", "nicaragua", "niger", "nigeria", "niue", "north-korea", "north-macedonia", "northern-ireland", "northern-mariana-islands", "norway", "oman", "other", "pakistan", "palau", "palestinian-territories", "panama", "papua-new-guinea", "paraguay", "peru", "philippines", "poland", "portugal", "principality-of-monaco", "puerto-rico", "qatar", "republic-of-congo", "romania", "russia", "rwanda", "saba", "saint-kitts-and-nevis", "samoa", "san-marino", "sao-tome-and-principe", "saudi-arabia", "scotland", "senegal", "serbia", "seychelles", "sierra-leone", "singapore", "sint-eustatius", "sint-maarten", "slovakia", "slovenia", "solomon-islands", "south-africa", "south-korea", "south-sudan", "spain", "sri-lanka", "st-lucia", "st-vincent-the-grenadines", "sudan", "surinam", "sweden", "switzerland", "syria", "taiwan", "tajikistan", "tanzania", "thailand", "togo", "tokelau", "tonga", "trinidad-and-tobago", "tunisia", "turkey", "turkmenistan", "turks-and-caicos-islands", "uganda", "ukraine", "united-arab-emirates", "united-states", "united-states-virgin-islands", "uruguay", "uzbekistan", "vanuatu", "venezuela", "vietnam", "wales", "yemen", "zambia", "zimbabwe" ], "type": "string", "description": "Scope the top-rated list to breweries from a single country, using Untappd's own country picker. Leave blank for all countries.", "default": "" }, "useProxy": { "title": "Use Apify proxy", "type": "boolean", "description": "Route requests through Apify's free datacenter (AUTO) proxy. Not required for normal operation; enable only if you observe blocking.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Only used when \"Use Apify proxy\" is enabled. Free AUTO datacenter group.", "default": { "useApifyProxy": true } }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 200, "type": "integer", "description": "Hard cap on emitted records. Note: Untappd limits anonymous (no-login) search results to 5 per query regardless of this value. mode=topRated is a single unpaginated page and delivers at most ~50 beers per style/country scope (Untappd exposes no further pages to anonymous visitors) -- narrow with topRatedStyle/topRatedCountry to get different sets of ~50 rather than expecting more per call. Use byBeerIds/byBreweryIds with an explicit ID list for larger, unbounded result sets.", "default": 20 } } }, "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 } } } } } } } } } }