警報/注意報検索

/weather_alert [GET]

基本情報

概要

指定された地点や住所における警報及び注意報を検索します。

禁止事項

データ提供元より許諾されていないため、本APIは警報及び注意報だけを
検索するようなコンテンツでの利用はお控えください。

URL

https://{HOST}/{CID}/v1/weather_alert

※Rakuten RapidAPIでは提供しておりません

出力形式

  • JSON

対応言語

  • ja

出力順

  • 住所コードの昇順

 

本 API を使用する際は、 利用規約の表示について にある規約を含めてください。

パラメータ

パラメータ名 必須 概要 型名 デフォルト値 上下限/選択値 備考
coord (✔) 緯度経度 カンマ区切りの数値(緯度, 経度) address及びlinkとの併用は不可
address (✔) 住所コード 文字列 coord及びlinkとの併用は不可
市区町村レベル(5桁)のみ指定可能
link (✔) 路線ID 文字列 coord及びaddressとの併用は不可
limit データの出力件数 数値 10 最小値:1
最大値:100
警報/注意報データの出力数
offset データの出力開始位置 数値 0 最小値:0
最大値:2000
何件目から表示されるか(1件目が0)を指定します
datum 緯度経度の測地系 文字列 wgs84 wgs84:世界測地系
tokyo:旧日本測地系
coord_unit 出力データに含まれる緯度経度の単位 文字列 degree degree:度表記の10進法
millisec:ミリ秒表記

パラメータ構成例

  • 新宿近辺の警報/注意報の情報を取得
/weather_alert?coord=35.691468,139.70353

レスポンス

名称 レスポンス名 型名 配列 説明
検索数 count Countオブジェクト
天気情報 items Alertオブジェクト
単位情報 unit Unitオブジェクト 出力される単位の情報

Countオブジェクト

名称 レスポンス名 型名 配列 説明
トータルヒット件数 total 数値 検索ヒットした件数
オフセット値 offset 数値 オフセットが設定されている場合はその値を出力
データの出力件数 limit 数値 データの出力件数に設定されている値
1件しかヒットしなかった場合でも、limit=10でリクエストしている場合は10と出力

Alertオブジェクト

名称 レスポンス名 型名 配列 説明
気象庁報告時刻 time 文字列
住所コード address_code 文字列
住所 address_name 文字列
緯度経度 coord Coordオブジェクト
警報/注意報の要約 summary 文字列
警報/注意報の詳細 detail 文字列 詳細データが存在する場合のみ出力
注意報 advisory Issueオブジェクト 注意報が存在する場合のみ出力
警報 warning Issueオブジェクト 警報が存在する場合のみ出力
特別警報 emergency_warning Issueオブジェクト 特別警報が存在する場合のみ出力

Issueオブジェクト

名称 レスポンス名 型名 配列 説明
発令名称 name 文字列

Coordinateオブジェクト

名称 レスポンス名 型名 配列 説明
緯度 lat 数値
経度 lon 数値

Unitオブジェクト

名称 レスポンス名 型名 配列 説明
測地系 datum 文字列
緯度経度の出力形式 coord_unit 文字列

レスポンス例

{
    "count": {
        "total": 1,
        "offset": 0,
        "limit": 10
    },
    "items": [
        {
            "time": "2021-03-22T10:14:00+09:00",
            "address_code": "13104",
            "address_name": "東京都新宿区",
            "coord": {
                "lat": 35.693889,
                "lon": 139.70341
            },
            "summary": "東京地方、伊豆諸島北部、伊豆諸島南部では、強風や高波に注意してください。伊豆諸島北部、伊豆諸島南部では、急な強い雨や落雷に注意してください。",
            "detail": "風 注意期間 22日夜遅くまで 北の風 最大風速 13メートル",
            "advisory": [
                {
                    "name": "強風注意報"
                }
            ]
        }
    ],
    "unit": {
        "datum": "wgs84",
        "coord_unit": "degree"
    }
}