# Boatrace Open API for Previews

> ボートレース（競艇）全 24 場の直前情報（気象・スタート展示・展示タイムなど）を、1 日 1 ファイルの JSON で配信する非公式 API です。GitHub Pages 上の静的ファイルで、認証は不要です。

**この API は非推奨です。** 新しくデータを取り込む場合は、出走表・直前情報・結果・払戻を 1 ファイルにまとめた後継の [boatraceopenapi/api](https://boatraceopenapi.github.io/api/llms.txt) を使ってください。この API は既存の利用のために更新を続けています。

## 取得方法

- 日別: `https://boatraceopenapi.github.io/previews/v3/YYYY/YYYYMMDD.json`（日付は JST、2016-08-01 以降）
- 当日・前日: `https://boatraceopenapi.github.io/previews/v3/today.json`・`yesterday.json`（約 3 時間ごとに上書き）
- v2（`/previews/v2/...`、2016-10-01 以降）はフィールド名が古い版です。新しく使うなら v3 にしてください。
- データがない日付は HTTP 404 を返します。
- 過去分を一括で取り込むときは、1 日ずつ順番に取得し、間隔を空けてください。取得したファイルはローカルに保存し、同じ日付を何度も取りに行かないでください。

## 必ず守ること

- `*_number` の多くはコード値です。数値として平均・並べ替え・比較せず、[コード表](https://boatraceopenapi.github.io/api/v1/codes.md) で意味に変換してください。
- `wind_direction_number` の「北」「東」などは地図上の方角ではなく、スタートラインに対する相対的な向きで、全 24 場共通です。`3`〜`7` が追い風、`11`〜`15` が向かい風、`17` が無風です。方角への変換やレース場ごとの補正はしないでください。
- レースのキーは `(date, stadium_number, number)`、出走艇のキーはそれに `racer_boat_number`（枠番）を加えたものです。
- `racer_course_number` はスタート展示の進入コースです。枠番と一致するとは限りません。
- `racer_exhibition_time`・`racer_weight` の `0` は欠損です。中止になったレースは値が `null` です。
- 本 API は約 3 時間ごとの取得なので、締切前の時点の直前情報があるとは限りません。過去データで予測モデルを作る場合も、締切前に分かる情報として扱えるかに注意してください。
- 当日のファイルは途中の状態です。確定した過去データとして使うのは、翌々日以降に取得したファイルにしてください。

## ドキュメント

- [スキーマ](https://boatraceopenapi.github.io/previews/schema.md): JSON の構造と全フィールドの説明、データの注意点、v2 との違い
- [コード表](https://boatraceopenapi.github.io/api/v1/codes.md): レース場・風向・天候などの番号と意味（後継 API と共通）

## その他

- 出走表は [programs](https://boatraceopenapi.github.io/programs/llms.txt)、結果・払戻は [results](https://boatraceopenapi.github.io/results/llms.txt) で配信しています。同じキーで結合できます。
- [README](https://github.com/boatraceopenapi/previews/blob/gh-pages/README.md): 注意事項・対応期間・ライセンス（MIT）
- 非公式のデータで、正確性は保証されていません。公式の情報は BOATRACE 公式サイトで確認してください。