BeerXML specification
Samovar accepts the BeerXML 1.0 format used by common brewing software.
Format
- Root order RECIPES, then one or more RECIPE records with HOPS, FERMENTABLES, YEASTS, MISCS, WATERS and an optional MASH.
- Quantities use BeerXML base units: kilograms, liters, Celsius and minutes.
- The portal import accepts one recipe per upload; extra records in the same document are ignored.
Example
Every catalog recipe is a working example, for instance 10 Heads High. Download BeerXML · View the recipe
Files and API
| Method | Path and parameters | Response |
|---|---|---|
| GET | /recipes?q&catalog&family&styleType&recipeType&source&abvMin&abvMax&ibuMin&ibuMax&sort&page&perPage&lang | Paged public recipe summaries |
| GET | /recipes/{slug}?lang | One public recipe as JSON |
| GET | /recipes/{slug}/beerxml | BeerXML document |
| GET | /calculators | Calculator definitions |
| POST | /calculators/{code}/calculate JSON {"inputs":{}} | Calculated outputs |
Public API base: https://www.samovar-tool.ru/beerxml/v1/
Errors
400 cheesexml_validation_error, 401 cheesexml_unauthorized, 404 cheesexml_not_found, 405 cheesexml_method_not_allowed. Every JSON error contains stable code and message fields.
