手牌画像API
麻雀の手牌をSVG画像として取得できるAPIです。ブログや解説記事に手牌画像を埋め込むことができます。
利用規約
- 無料で利用できます
- 商用利用可
- 画像を使用する際は、以下のクレジットリンクの設置が必須です
<a href="https://janten.net">雀天</a>表示例: 雀天
- 過度なリクエスト（1分あたり100回以上）は制限する場合があります
- 本APIは予告なく仕様変更・停止する場合があります
エンドポイント
GET https://janten.net/api/mahjong/tehaiレスポンス: image/svg+xml（24時間キャッシュ）
パラメータ
| 名前 | 必須 | 説明 | 例 |
|---|---|---|---|
tiles | 必須 | 手牌の記法。数字+スーツ文字で指定。m=萬子, p=筒子, s=索子, z=字牌(1東2南3西4北5白6發7中)。例: "123m456p789s11z" | 123m456p789s11z |
tsumo | ツモ牌。手牌の右側に少し離して表示される。 | 3m | |
dora | ドラ表示牌。ドラに該当する牌が黄色でハイライトされる。 | 2m | |
melds | 副露（鳴き）。"種類:牌牌牌" のカンマ区切り。種類: pon, chi, ankan, minkan。 | pon:5z5z5z,chi:3s4s5s | |
discards | 捨て牌。手牌の下に表示される。 | 1z2z3p8s | |
shanten | "true" を指定すると向聴数を自動計算して表示（13枚以上の手牌が必要）。 | true | |
waits | "true" を指定すると待ち牌を自動計算して表示（13枚の手牌が必要）。 | true | |
theme | 配色テーマ。green(既定), dark, white, classic。 | green | |
size | 画像サイズ。small, medium(既定), large, ogp(1200x630)。 | medium | |
nosort | "true" を指定すると手牌をソートせずそのまま表示。 | true | |
nobg | "true" を指定すると背景を透明にする。 | true |
牌の記法
| スーツ | 文字 | 範囲 | 例 |
|---|---|---|---|
| 萬子 | m | 1〜9 | 123m = 一二三萬 |
| 筒子 | p | 1〜9 | 456p = 四五六筒 |
| 索子 | s | 1〜9 | 789s = 七八九索 |
| 字牌 | z | 1〜7 | 1z=東, 2z=南, 3z=西, 4z=北, 5z=白, 6z=發, 7z=中 |
| 赤牌 | 0 | 0m, 0p, 0s | 0m = 赤五萬 |
サンプル
基本の手牌
https://janten.net/api/mahjong/tehai?tiles=123m456p789s11z&tsumo=7zHTMLでの埋め込み
<img src="https://janten.net/api/mahjong/tehai?tiles=123m456p789s11z&tsumo=7z" alt="手牌">
<a href="https://janten.net">雀天</a>Markdownでの埋め込み
[雀天](https://janten.net)