Skip to main content

Tea knowledge API client — search tea varieties, processing methods, and terms from TeaFYI.

Project description

teafyi

PyPI version Python License: MIT

Tea knowledge API client for Python. Search 60 tea varieties, 15 origin countries, 15 teaware items, and tea terminology from TeaFYI -- the comprehensive tea reference with 120 expert guides covering oxidation science, processing methods, brewing parameters, and the world's tea traditions.

Explore tea at teafyi.com -- | | Teaware | Tea Guides

teafyi demo -- tea variety API search and lookup

Table of Contents

Install

pip install teafyi[api]     # API client (httpx)
pip install teafyi[cli]     # + CLI (typer, rich)
pip install teafyi[mcp]     # + MCP server
pip install teafyi[all]     # Everything

Quick Start

from teafyi.api import TeaFYI

with TeaFYI() as api:
    # Search tea varieties, origins, teaware, glossary terms
    results = api.search("matcha")
    print(results)

    # Look up a glossary term
    term = api.glossary_term("oxidation")
    print(term["definition"])

What You'll Find on TeaFYI

TeaFYI is a comprehensive tea reference covering 60 tea varieties, 15 origin countries, 15 teaware items, and 120 expert guides. All true tea comes from a single plant species -- Camellia sinensis -- and the vast differences between a delicate white tea and a robust black tea are created entirely through processing, particularly the degree of oxidation.

Tea Categories by Oxidation

Tea is classified into six major categories based on oxidation level -- the enzymatic browning process that occurs when tea leaves are exposed to oxygen after picking. Oxidation is the single most important factor determining a tea's character:

Category Oxidation Processing Characteristics
Green 0-5% Kill-green (pan-fired or steamed), rolled, dried Vegetal, grassy, sweet, bright green liquor
White 0-10% Minimal processing, withered and dried Delicate, floral, honey, subtle sweetness
Yellow 5-15% Kill-green, wrapped/heaped (men huan), dried Mellow, smooth, less grassy than green
Oolong 15-85% Withered, bruised, partial oxidation, shaped Complex range from floral to toasty
Black 85-100% Withered, rolled, fully oxidized, dried Malty, robust, tannic, amber-red liquor
Pu-erh Post-fermented Microbial fermentation (sheng or shou) Earthy, woody, complex, ages for decades

Herbal infusions (chamomile, rooibos, peppermint) are technically tisanes, not tea, as they do not come from Camellia sinensis. TeaFYI covers both categories.

Learn more: Browse Tea Categories · ### Processing Methods

Beyond oxidation, specific processing steps create the diversity within each tea category:

Process Description Applied To
Kill-Green (Sha Qing) Heat stops oxidation -- pan-fired or steamed Green, Yellow
Withering Leaves lose moisture, become pliable White, Oolong, Black
Rolling/Shaping Breaks cell walls, releases oils, shapes leaf Green, Oolong, Black
CTC (Cut-Tear-Curl) Machine processing for consistent, strong brew CTC Black (tea bags)
Orthodox Hand-plucked, gentle processing, whole leaf Specialty loose leaf
Pile Fermentation (Wo Dui) Accelerated microbial aging in humid conditions Shou (Ripe) Pu-erh

The distinction between CTC and orthodox processing is fundamental: CTC produces small, uniform granules that brew quickly and strongly (ideal for tea bags and chai), while orthodox processing preserves whole leaves with more nuanced, complex flavor (ideal for gongfu brewing).

Learn more: Processing Methods · Tea Glossary

Teaware

TeaFYI catalogs 15 teaware items with materials, origins, and recommended uses. The brewing vessel profoundly affects tea character -- porous Yixing clay absorbs tea oils over time, while glass and porcelain offer neutral, clean extraction:

Teaware Material Origin Best For
Gaiwan Porcelain China Universal, gongfu brewing
Yixing Teapot Zisha clay Yixing, China Oolong, Pu-erh, dedicated to one tea type
Kyusu Ceramic Japan Japanese green tea (sencha, gyokuro)
Tetsubin Cast iron Japan Boiling water, heat retention
Glass Teapot Borosilicate Modern Flowering tea, visual appreciation
Chasen Bamboo whisk Japan Matcha preparation

Learn more: Teaware Guide · Brewing Guides

Key Tea Concepts

Concept Description
First Flush First spring harvest, prized for freshness and delicacy (Darjeeling, Shincha)
Second Flush Summer harvest, fuller body and muscatel character
Terroir Altitude, soil, climate, and fog patterns that create regional character
Gongfu Cha Chinese brewing method: small vessel, high leaf ratio, multiple short infusions
Caffeine Content Varies by processing: matcha highest (~70mg/cup), white tea lowest (~15-30mg/cup)
L-Theanine Amino acid unique to tea, promotes calm alertness, highest in shade-grown teas

Learn more: Tea Compounds

API Endpoints

All endpoints are free, require no authentication, and return JSON with CORS enabled.

Method Endpoint Description
GET /api/v1/teas/ List all 60 tea varieties
GET /api/v1/teas/{slug}/ Tea variety detail with brewing params
GET /api/v1/origins/ List all 15 origin countries
GET /api/v1/origins/{slug}/ Origin detail with regions, climate
GET /api/v1/teaware/ List all 15 teaware items
GET /api/v1/teaware/{slug}/ Teaware detail with materials, use
GET /api/v1/glossary/ List all tea terminology
GET /api/v1/glossary/{slug}/ Glossary term definition
GET /api/v1/search/?q={query} Search across all content
GET /api/v1/compare/{slug1}/{slug2}/ Compare two tea varieties
GET /api/v1/random/ Random tea variety
GET /api/v1/guides/ List all 120 guides
GET /api/v1/guides/{slug}/ Guide detail
GET /api/v1/openapi.json OpenAPI 3.1.0 specification

Example

curl -s ""
{
  "slug": "matcha",
  "name": "Matcha",
  "category": "Green",
  "description": "Stone-ground Japanese green tea powder made from shade-grown tencha leaves, whisked with hot water for a rich, umami-forward brew.",
  "origin": "Japan",
  "oxidation": "0%",
  "caffeine": "high",
  "flavor_profile": ["umami", "vegetal", "sweet", "creamy"],
  "brewing": {
    "temperature": "70-80C",
    "amount": "2g per 60ml",
    "method": "Whisk with chasen until frothy"
  },
  "url": "matcha/"
}

Full API documentation: teafyi.com/developers/. OpenAPI 3.1.0 spec: .

Command-Line Interface

# Search tea varieties, origins, teaware
teafyi search "matcha"
teafyi search "oolong"
teafyi search "gongfu ceremony"
teafyi search "darjeeling"

# Look up tea terminology
teafyi term "oxidation"
teafyi term "first-flush"
teafyi term "gaiwan"

The CLI displays results in formatted tables with rich terminal output.

MCP Server (Claude, Cursor, Windsurf)

Run as an MCP server for AI-assisted tea queries:

python -m teafyi.mcp_server

Claude Desktop (~/.claude/claude_desktop_config.json):

{
  "mcpServers": {
    "teafyi": {
      "command": "uvx",
      "args": ["--from", "teafyi[mcp]", "python", "-m", "teafyi.mcp_server"]
    }
  }
}

Tools: tea_search, tea_glossary_term

API Client

from teafyi.api import TeaFYI

with TeaFYI() as api:
    # Search across teas, origins, teaware, glossary
    results = api.search("oolong")

    # Look up tea terminology
    term = api.glossary_term("gongfu")
    print(term["definition"])

    # Compare two tea varieties
    comparison = api.compare("sencha", "matcha")

    # Get a random tea variety
    random_tea = api.random()

Learn More About Tea

Part of the FYIPedia open-source developer tools ecosystem -- world beverages from cocktails to sake.

Site Domain Focus
CocktailFYI cocktailfyi.com 636 cocktails, ABV, calories, flavor profiles
VinoFYI vinofyi.com Wines, grapes, regions, wineries, food pairings
BeerFYI beerfyi.com 112 beer styles, hops, malts, yeast, BJCP
BrewFYI brewfyi.com 72 coffee varieties, roasting, 21 brew methods
WhiskeyFYI whiskeyfyi.com 80 whiskey expressions, distilleries, regions
TeaFYI teafyi.com 60 tea varieties, teaware, brewing guides
NihonshuFYI nihonshufyi.com 80 sake, rice varieties, 50 breweries

Embed Widget

Embed TeaFYI widgets on any website with teafyi-embed:

<script src="https://cdn.jsdelivr.net/npm/teafyi-embed@1/dist/embed.min.js"></script>
<div data-teafyi="entity" data-slug="example"></div>

Zero dependencies · Shadow DOM · 4 themes (light/dark/sepia/auto) · Widget docs

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

teafyi-0.1.4.tar.gz (559.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

teafyi-0.1.4-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

Details for the file teafyi-0.1.4.tar.gz.

File metadata

  • Download URL: teafyi-0.1.4.tar.gz
  • Upload date:
  • Size: 559.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for teafyi-0.1.4.tar.gz
Algorithm Hash digest
SHA256 79689e5dcfd834c667716329dbaf63eaea3c0b81917fb333e086dc70ae0de13b
MD5 a98839b7a11a328f3ac6b800245e4ace
BLAKE2b-256 1e8c55daf9634294a3a0cede73c4698d73e32d82312960a521f12e3366922016

See more details on using hashes here.

File details

Details for the file teafyi-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: teafyi-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 10.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for teafyi-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c83bf2f70663c248027b2e3f93d1a81946c6d6dffa753e09c9b018638ce9a90a
MD5 63060c7fb291bb225fddf5da374b2802
BLAKE2b-256 a3843985ef5a85057d06b0128f0a1c0d1322a94d7f058eefc62a57660274194a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page