祝日情報 API リファレンス
祝日情報を取得するためのAPIを提供しています。年単位での取得と期間指定での取得の2つの方法があります。
エンドポイント一覧
パス | メソッド | 説明 |
---|---|---|
/holidays/api/list/ | GET | 年指定で祝日を取得。クエリパラメータで年を指定(?year=2024)。指定がない場合は全件取得。 |
/holidays/api/filter/ | GET | 期間指定で祝日を取得。開始日(from)と終了日(to)をyyyymmdd形式で指定。 |
年指定での祝日取得
リクエスト
GET /holidays/api/list/
クエリパラメータ
パラメータ名 | 型 | 必須 | 説明 |
---|---|---|---|
year | 数値 | 任意 | 取得したい年(2020〜2030)。指定しない場合は全件取得。 |
レスポンス
正常時のレスポンス例:
[
{
"date": "2024-01-01",
"name": "元日"
},
{
"date": "2024-01-08",
"name": "成人の日"
}
]
エラー時のレスポンス例:
{
"error": "年は2020年から2030年の間で指定してください。"
}
使用例
Python での実行例:
import requests
# 2024年の祝日を取得
response = requests.get('https://flask.pc5bai.com/holidays/api/list/?year=2024')
print(response.json())
# 全ての祝日を取得
response = requests.get('https://flask.pc5bai.com/holidays/api/list/')
print(response.json())
curl での実行例:
# 2024年の祝日を取得
curl "https://flask.pc5bai.com/holidays/api/list/?year=2024"
# 全ての祝日を取得
curl "https://flask.pc5bai.com/holidays/api/list/"
期間指定での祝日取得
リクエスト
GET /holidays/api/filter/
クエリパラメータ
パラメータ名 | 型 | 必須 | 説明 |
---|---|---|---|
from | 文字列 | 必須 | 開始日(yyyymmdd形式) |
to | 文字列 | 必須 | 終了日(yyyymmdd形式) |
レスポンス
正常時のレスポンス例:
[
{
"date": "2024-01-01",
"name": "元日"
},
{
"date": "2024-01-08",
"name": "成人の日"
},
{
"date": "2024-02-11",
"name": "建国記念の日"
}
]
エラー時のレスポンス例:
{
"error": "from, to は yyyymmdd 形式で指定してください"
}
使用例
Python での実行例:
import requests
# 2024年1月から3月までの祝日を取得
response = requests.get(
'https://flask.pc5bai.com/holidays/api/filter/',
params={'from': '20240101', 'to': '20240331'}
)
print(response.json())
curl での実行例:
# 2024年1月から3月までの祝日を取得
curl "https://flask.pc5bai.com/holidays/api/filter/?from=20240101&to=20240331"
共通仕様
レスポンスヘッダー
全てのAPIレスポンスには以下のヘッダーが設定されています:
Content-Type: application/json; charset=utf-8
エラーレスポンス
エラー時は400系のステータスコードとともに、エラーメッセージがJSONで返されます。
ステータスコード | 説明 |
---|---|
400 | リクエストパラメータが不正 |