Documentation
Complete reference for Yoriichi — the Transparent World for Solana DEX data.
Installation
Install Yoriichi via pip:
Terminalbash
pip install yoriichiOr from source:
Terminalbash
git clone https://github.com/theyoriichi/Yoriichi.git
cd Yoriichi
pip install -e .Python 3.8+MIT License
Quick Start
Read DEX data and get Yoriichi's analysis:
example.pypython
from yoriichi import read, read_batch, strongest_dex
from yoriichi.models import DexToken
token = DexToken(
token_mint="YoriXyz...pump",
symbol="YORI",
dex_volume_24h=800_000.0,
dex_volume_7d_avg=400_000.0,
liquidity_usd=500_000.0,
swap_count_24h=2000,
swap_count_7d_avg=800.0,
price_impact_avg=0.3,
unique_traders_24h=600,
buy_sell_ratio=1.6,
pool_count=6,
)
report = read(token)
print(report.phase) # ASCENDANT
print(report.breathing_score) # 88.4
print(report.is_active) # True
print(report.yoriichi_read)
# "Transparent World. Yoriichi sees every swap..."Batch Reading
Process multiple tokens at once:
batch.pypython
reports = read_batch([token1, token2, token3])
best = strongest_dex([token1, token2, token3])
print(f"Strongest DEX signal: {best.symbol} — {best.phase}")Phases
DORMANT0-25
"Yoriichi sees nothing. No liquidity. No traders. No momentum. He waits."
AWAKENING26-50
"Yoriichi's eyes open. Liquidity is forming. The first swaps are appearing. He is watching."
SLAYING51-75
"Yoriichi has drawn his blade. Volume is real. Traders are moving. The DEX is alive."
ASCENDANT76-100
"Transparent World. Yoriichi sees every swap, every pool, every wallet. This is what real on-chain looks like."
Run Tests
143 tests. 5 files. 100% pass rate.
Terminalbash
pytest tests/ -vDocker
Run Yoriichi in a container:
Terminalbash
docker-compose up --build