Skip to content

Commit 00955d4

Browse files
committed
docs: update README.md
1 parent 2a395e2 commit 00955d4

1 file changed

Lines changed: 28 additions & 15 deletions

File tree

README.md

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,41 @@
1-
# Boatrace Open API for Previews
1+
# 🚤 Boatrace Open API for Previews
22

33
[![cron](https://github.com/BoatraceOpenAPI/previews/actions/workflows/cron.yml/badge.svg)](https://github.com/BoatraceOpenAPI/previews/actions/workflows/cron.yml)
44
[![pages-build-deployment](https://github.com/BoatraceOpenAPI/previews/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/BoatraceOpenAPI/previews/actions/workflows/pages/pages-build-deployment)
55
[![issues](https://img.shields.io/github/issues/BoatraceOpenAPI/previews.svg)](https://github.com/BoatraceOpenAPI/previews/issues)
66
[![pulls](https://img.shields.io/github/issues-pr/BoatraceOpenAPI/previews.svg)](https://github.com/BoatraceOpenAPI/previews/pulls)
77
[![license](https://img.shields.io/badge/license-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
88

9-
ボートレース(競艇)の直前情報データが取得可能な Web API です。
10-
GitHub Pages を用いて静的な JSON ファイルとして配信しています。
9+
## ⚠️ 注意事項
10+
>
11+
> ⚡ 本 API は**非公式**であり、BOATRACE 公式サイト・団体とは一切関係ありません。<br>
12+
> 🕒 データはリアルタイム更新ではなく、**約30分間隔で更新**されます。<br>
13+
> 🔍 データの正確性・完全性を保証するものではありません。<br>
14+
> 🙇‍♂️ 利用は自己責任でお願いします。
1115
12-
## エンドポイント
13-
```
14-
https://boatraceopenapi.github.io/previews/v2/{日付}.json
16+
## 📌 概要
17+
この API では、ボートレース(競艇)の直前情報データを取得できます。<br>
18+
データは GitHub Pages 上で公開されており、JSON形式で提供されます。
19+
20+
## 🌐 エンドポイント
21+
```bash
22+
https://boatraceopenapi.github.io/previews/v2/YYYY/YYYYMMDD.json
1523
```
1624

17-
## サンプル
18-
- [https://boatraceopenapi.github.io/previews/v2/20250715.json](https://boatraceopenapi.github.io/previews/v2/20250715.json)
19-
- [https://boatraceopenapi.github.io/previews/v2/today.json](https://boatraceopenapi.github.io/previews/v2/today.json)
25+
📅 YYYY → 年<br>
26+
📅 YYYYMMDD → 年月日
27+
28+
## 🧩 サンプル
29+
- 2025年07月15日の直前情報
30+
- [https://boatraceopenapi.github.io/previews/v2/2025/20250715.json](https://boatraceopenapi.github.io/previews/v2/2025/20250715.json)
31+
- 本日の直前情報
32+
- [https://boatraceopenapi.github.io/previews/v2/today.json](https://boatraceopenapi.github.io/previews/v2/today.json)
2033

21-
## 関連
22-
| 対象 | リポジトリ | エンドポイント |
23-
|:---|:---|:---|
24-
| 出走表 | [Boatrace Open API for Programs](https://github.com/BoatraceOpenAPI/programs) | https://boatraceopenapi.github.io/programs/v2/{日付}.json |
25-
| 結果 | [Boatrace Open API for Results](https://github.com/BoatraceOpenAPI/results) | https://boatraceopenapi.github.io/results/v2/{日付}.json |
34+
## 🔗 関連リポジトリ
35+
| 🏷️ 対象 | 📂 リポジトリ |
36+
|:--|:--|
37+
| 🐆 出走表 | [Boatrace Open API for Programs](https://github.com/BoatraceOpenAPI/programs) |
38+
| 🏆 結果 | [Boatrace Open API for Results](https://github.com/BoatraceOpenAPI/results) |
2639

27-
## ライセンス
40+
## 📄 ライセンス
2841
Boatrace Open API for Previews は [MITライセンス](LICENSE) の元で公開されています。

0 commit comments

Comments
 (0)