Skip to content

Commit 6b9f0c9

Browse files
authored
Merge pull request #42 from BoatraceOpenAPI/doc/issue-41-readme
docs: update README.md
2 parents e01e200 + adf9893 commit 6b9f0c9

1 file changed

Lines changed: 25 additions & 19 deletions

File tree

README.md

Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,41 @@
1-
# Boatrace Open API for Programs
1+
# 🚤 Boatrace Open API for Programs
22

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

9-
> **⚠️ 注意事項**
9+
## ⚠️ 注意事項
1010
>
11-
> 本 API は**非公式**であり、BOATRACE 公式サイト・団体とは一切関係ありません。
12-
> データはリアルタイム更新ではなく、**約30分間隔で更新**されます。
13-
> データの正確性・完全性を保証するものではありません。
14-
> 利用は自己責任でお願いします。
11+
> 本 API は**非公式**であり、BOATRACE 公式サイト・団体とは一切関係ありません。<br>
12+
> 🕒 データはリアルタイム更新ではなく、**約30分間隔で更新**されます。<br>
13+
> 🔍 データの正確性・完全性を保証するものではありません。<br>
14+
> 🙇‍♂️ 利用は自己責任でお願いします。
1515
16-
ボートレース(競艇)の出走表データを取得できる Web API です。
17-
データは GitHub Pages 上で公開されており、JSON 形式で提供しています。
16+
## 📌 概要
17+
この API では、ボートレース(競艇)の出走表データを取得できます。<br>
18+
データは GitHub Pages 上で公開されており、JSON形式で提供されます。
1819

19-
## エンドポイント
20-
```
20+
## 🌐 エンドポイント
21+
```bash
2122
https://boatraceopenapi.github.io/programs/v2/YYYY/YYYYMMDD.json
2223
```
2324

24-
## サンプル
25-
- [https://boatraceopenapi.github.io/programs/v2/2025/20250715.json](https://boatraceopenapi.github.io/programs/v2/2025/20250715.json)
26-
- [https://boatraceopenapi.github.io/programs/v2/today.json](https://boatraceopenapi.github.io/programs/v2/today.json)
25+
📅 YYYY → 年<br>
26+
📅 YYYYMMDD → 年月日
27+
28+
## 🧩 サンプル
29+
- 2025年07月14日の出走表
30+
- [https://boatraceopenapi.github.io/programs/v2/2025/20250714.json](https://boatraceopenapi.github.io/programs/v2/2025/20250714.json)
31+
- 本日の出走表
32+
- [https://boatraceopenapi.github.io/programs/v2/today.json](https://boatraceopenapi.github.io/programs/v2/today.json)
2733

28-
## 関連
29-
| 対象 | リポジトリ | エンドポイント |
30-
|:---|:---|:---|
31-
| 直前情報 | [Boatrace Open API for Previews](https://github.com/BoatraceOpenAPI/previews) | https://boatraceopenapi.github.io/previews/v2/YYYY/YYYYMMDD.json |
32-
| 結果 | [Boatrace Open API for Results](https://github.com/BoatraceOpenAPI/results) | https://boatraceopenapi.github.io/results/v2/YYYY/YYYYMMDD.json |
34+
## 🔗 関連リポジトリ
35+
| 🏷️ 対象 | 📂 リポジトリ |
36+
|:--|:--|
37+
| ⏱️ 直前情報 | [Boatrace Open API for Previews](https://github.com/BoatraceOpenAPI/previews) |
38+
| 🏆 結果 | [Boatrace Open API for Results](https://github.com/BoatraceOpenAPI/results) |
3339

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

0 commit comments

Comments
 (0)