whiskeyfyi
v0.1.0
Published
TypeScript API client for WhiskeyFYI -- whiskey expressions, distilleries, cask types, and regions. Zero dependencies.
Maintainers
Readme
whiskeyfyi
TypeScript API client for WhiskeyFYI -- the comprehensive whiskey reference with 80 whiskey expressions, 500+ distilleries across 7 countries and 13 regions, cask types, and 150 expert guides covering single malts, bourbons, cask maturation, and tasting methodology. Zero dependencies, uses native fetch.
Explore whiskey at whiskeyfyi.com -- Whiskeys | Distilleries | Regions | API Docs
Table of Contents
- Install
- Quick Start
- What You Can Do
- API Reference
- TypeScript Types
- Learn More About Whiskey
- Also Available for Python
- Beverage FYI Family
- License
Install
npm install whiskeyfyiWorks in Node.js, Deno, Bun, and browsers (ESM).
Quick Start
import { WhiskeyFYI } from "whiskeyfyi";
const api = new WhiskeyFYI();
// Search whiskeys, distilleries, regions, glossary
const results = await api.search("bourbon");
// Get whiskey expression detail with tasting notes
const whiskey = await api.expression("lagavulin-16");
console.log(whiskey.abv); // 43.0
console.log(whiskey.tasting_notes); // { nose: [...], palate: [...], finish: [...] }
// Get cask type flavor contributions
const cask = await api.cask("ex-bourbon");
console.log(cask.flavor_contribution);
// Compare two expressions
const comparison = await api.compare("lagavulin-16", "laphroaig-10");What You Can Do
Whiskey Types
Whiskey classification is governed by legal definitions that vary by country:
| Type | Country | Key Requirements | |------|---------|-----------------| | Scotch Single Malt | Scotland | 100% malted barley, pot still, 3+ years | | Bourbon | United States | 51%+ corn, new charred oak barrels | | Tennessee | United States | Bourbon + Lincoln County Process | | Rye (American) | United States | 51%+ rye grain, new charred oak | | Irish Whiskey | Ireland | 3+ years aging, triple distillation common | | Japanese Whisky | Japan | Scotch-influenced, precision crafting |
Learn more: Whiskey Types -- Whiskey Encyclopedia
Cask Types and Maturation
Maturation accounts for 60-80% of a whiskey's final flavor:
| Cask Type | Capacity | Flavor Contribution | |-----------|----------|---------------------| | Ex-Bourbon | 200L | Vanilla, caramel, coconut | | Sherry (Oloroso) | 500L | Dried fruit, nuts, chocolate | | Port | 500L | Berry fruit, plum | | Virgin Oak | 200L | Strong oak, tannins, spice | | Mizunara | 480L | Sandalwood, incense |
Learn more: Cask Types -- Whiskey Glossary
Whiskey Regions
13 whiskey-producing regions with distinctive characteristics:
| Region | Country | Characteristics | |--------|---------|-----------------| | Speyside | Scotland | Elegant, fruity, honeyed | | Islay | Scotland | Heavily peated, maritime, smoky | | Highland | Scotland | Diverse, from light to robust | | Kentucky | USA | Bourbon heartland, limestone water | | Yamazaki | Japan | Precision crafting, varied yeast |
API Reference
| Method | Description |
|--------|-------------|
| search(query) | Search whiskeys, distilleries, regions, glossary |
| glossaryTerm(slug) | Get glossary term definition |
| expression(slug) | Whiskey expression detail with tasting notes |
| distillery(slug) | Distillery detail with history |
| type(slug) | Whiskey type detail |
| cask(slug) | Cask type detail with flavor contributions |
| region(slug) | Region detail with characteristics |
| compare(slugA, slugB) | Compare two whiskey expressions |
| random() | Random whiskey expression |
TypeScript Types
import type { SearchResult, GlossaryTerm, ExpressionDetail, DistilleryDetail, TypeDetail, CaskDetail, RegionDetail, CompareResult, RandomResult } from "whiskeyfyi";Learn More About Whiskey
- Reference: Whiskeys | Distilleries | Regions
- Guides: Whiskey Guides | Glossary
- API: Developer Docs | OpenAPI Spec
- Python: PyPI Package
Also Available for Python
pip install whiskeyfyiSee the Python package on PyPI.
Beverage FYI Family
Part of the FYIPedia open-source developer tools ecosystem -- world beverages from cocktails to sake.
| Package | PyPI | npm | Description | |---------|------|-----|-------------| | cocktailfyi | PyPI | npm | 636 cocktails, ABV, calories -- cocktailfyi.com | | vinofyi | PyPI | npm | Wines, grapes, regions, food pairings -- vinofyi.com | | beerfyi | PyPI | npm | 112 beer styles, hops, malts -- beerfyi.com | | brewfyi | PyPI | npm | 72 coffee varieties, brew methods -- brewfyi.com | | whiskeyfyi | PyPI | npm | 80 whiskey expressions, distilleries -- whiskeyfyi.com | | teafyi | PyPI | npm | 60 tea varieties, teaware -- teafyi.com | | nihonshufyi | PyPI | npm | 80 sake, rice varieties -- nihonshufyi.com |
License
MIT
