地震情報APIの仕様書

こんにちはっ！なりかくんです。
今回は、僕が制作している地震情報APIの仕様をまとめましたので紹介します。

リクエスト

リクエストURL	https://dev.narikakun.net/webapi/earthquake/post_data.json
リクエストメゾット	GET
リクエスト制限	5req/s以上のリクエストを行わないでください。 ※特にサーバー側での制限はしておりませんが、ひどい場合は手動でアクセス制限いたします。

テスト用JSON

レスポンス

		説明	出現回数	値
Control	JSON	本情報の配信に関連する情報を記載する。	1回
Control.Title	String	本情報の配信のタイトルを記載する。	1回
Control.DateTime	String	気象庁システムからの発信時刻を記載する。	1回
Control.Status	String	通常の運用で発表する情報には”通常”と記載する。事前に日程を定めて行う業務等で発表する情報には”訓練”と記載する。	1回	通常 / 訓練 / 試験
Control.EditorialOffice	String	本情報の編集官署名を記載する。システム障害発生等により一連の情報であっても編集官署が切り替わることがあることに留意が必要である。	1回
Control.PublishingOffice	String	発表官署名を記載する。	1回
Head	JSON	本情報の見出しを記載する。	1回
Head.Title	String	情報の標題を記載する。	1回
Head.ReportDateTime	String	発表官署が本情報を発表した時刻を記載する。	1回
Head.TargetDateTime	String	情報の内容が発現・発効する基点時刻を記載する。震度速報については地震波の検知時刻を記載する。その他の地震・津波・火山に関連する情報については、ヘッダ部の発表時刻（Head.ReportDateTime）の値を記載する	1回
Head.EventID	String	地震に関連する情報については、ある特定の地震を識別するための地震識別番号（14 桁の数字）を記載する。震識別番号を記載するため、１つの電文に複数の地震識別番号が出現する場合もある。	1回
Head.InfoType	String	情報を発表する場合は“発表”を、直前の時点で発表されている Control.DateTime の最も新しい電文を訂正する場合は“訂正”を、全体を取り消す場合は“取消”を記載する。	1回
Head.Serial	String	続報を発表し、内容を更新する情報については、情報番号を記載する。続報を発表する度に情報番号を更新するが、取消報の場合は、番号は更新しない。訂正報の場合は訂正する直近の情報の情報番号を記載する。 ※なお、同一種別の情報における最新情報の検索にあたっては、本要素ではなく管理部の発表時刻（Control.DateTime）を参照すること。	1回
Head.InfoKind	String	スキーマの運用種別情報を記載する。	1回
Head.InfoKindVersion	String	スキーマの運用種別情報のバージョン番号を記載する。	1回
Head.Headline	String	子要素にText及びInformationをもつ。	1回

震源・震度に関する情報

		説明	出現回数	値
Body	JSON	本情報の量的な詳細内容を記載する	1回
Body.Earthquake	JSON	地震の諸要素（発生日時、震央地名、震源要素、マグニチュード等）を記載する。ヘッダ部の「情報形態」（Head.InfoType）が“取消”の場合、本要素は出現しない。	0回/1回
Body.Earthquake.OriginTime	String	地震の発生した時刻を記載する。	1回
Body.Earthquake.ArrivalTime	String	観測点で地震を検知した時刻（発現時刻）を記載する。ただし、国外で発生した地震で発現時刻が不明の場合、「地震発生時刻」（Body.Earthquake.OriginTime）の値を記載する。	1回
Body.Earthquake.Hypocenter	JSON	地震の位置に関する要素（震央地名、震源要素等）を記載する。	1回
Body.Earthquake.Hypocenter.Name	String	震央地名を記載する。	1回
Body.Earthquake.Hypocenter.Code	String	震央地名に対応するコードを記載する。	1回
Body.Earthquake.Hypocenter.Depth	String	深さをメートル単位で記載する。記載する深さの値は、深さ 700km より浅いところでは 10,000 メートルの単位で有効である。	1回
Body.Earthquake.Hypocenter.Longitude	String	震源の経度を記載する。	1回
Body.Earthquake.Hypocenter.Latitude	String	震源の緯度を記載する。	1回
Body.Earthquake.Hypocenter.Coordinate	String	震源要素を記載する。	1回
Body.Earthquake.Magnitude	String	地震のマグニチュードの値を記載する。る。マグニチュードが不明の場合やマグニチュードが 8 を超える巨大地震と推定される場合は、NaNと記載される。	1回
Body.Earthquake.Magnitude_description	String	地震のマグニチュードの文字列表現を記載する。マグニチュードが不明の場合は、”Ｍ不明”と記載される。マグニチュードが 8 を超える巨大地震と推定される場合は、”Ｍ８を超える巨大地震”と記載される。	1回
Body.Intensity	JSON	国内で震度が観測された場合は、その震度に関する情報を記載する。国内で震度が観測されない場合、又はヘッダ部の「情報形態」（Head.InfoType）が“取消”の場合、本要素は出現しない。	0回/1回
Body.Intensity.Observation	JSON	震度の観測に関する諸要素を記載する。	1回
Body.Intensity.Observation.MaxInt	String	本情報で発表する最大の震度を記載する。	1回	1 / 2 / 3 / 4 / 5- / 5+ / 6- / 6+ / 7
Body.Intensity.Observation.Pref	Array	都道府県毎の震度の観測状況を記載する。震度を観測した都道府県の数に応じて、本要素が複数出現する。子要素 Name に都道府県名を記載し、対応するコードを子要素 Code に記載する。	1回以上
Body.Intensity.Observation.Pref.MaxInt	String	当該都道府県における最大震度を記載する。当該都道府県内に、基準となる震度以上（当面は震度５弱以上とする）と考えられるが震度の値を入手していない市町村のみしか存在しない場合、本要素は出現しない。	0回/1回	1 / 2 / 3 / 4 / 5- / 5+ / 6- / 6+ / 7
Body.Intensity.Observation.Pref.Area	Array	地域毎の震度の観測状況を記載する。震度を観測した地域の数に応じて、本要素が複数出現する。子要素 Name に地域名を記載し、対応するコードを子要素Code に記載する。	1回以上
Body.Intensity.Observation.Pref.Area.MaxInt	String	当該地域における最大震度を記載する。当該地域内に、基準となる震度以上（当面は震度５弱以上とする）と考えられるが震度の値を入手していない市町村のみしか存在しない場合、本要素は出現しない。	0回/1回	1 / 2 / 3 / 4 / 5- / 5+ / 6- / 6+ / 7
Body.Intensity.Observation.Pref.Area.City	Array	市町村毎の震度の観測状況を記載する。震度を観測した市町村の数に応じて、本要素が複数出現する。子要素 Name に市町村名を記載し、対応するコードを子要素Code に記載する。当該市町村の中に、基準となる震度以上と考えられるが震度の値を入手していない震度観測点が存在する。	1回以上
Body.Intensity.Observation.Pref.Area.City.MaxInt	String	当該市町村における最大震度を記載する。当該市町村内に、基準となる震度以上（当面は震度５弱以上とする）と考えられるが震度の値を入手していない震度観測点のみしか存在しない場合、本要素は出現しない。	0回/1回	1 / 2 / 3 / 4 / 5- / 5+ / 6- / 6+ / 7
Body.Intensity.Observation.Pref.Area.City.IntensityStation	Array	親要素 City に記載した市町村に所属する震度観測点について、観測点毎の震度の観測状況を記載する。震度を観測した観測点の数に応じて、本要素が複数出現する。子要素 Name に観測点名を記載し、対応するコードを子要素Code に記載する。子要素 Int に当該観測点における震度を記載する。当該観測点の震度が基準となる震度以上と考えられるが震度の値を入手していない場合に、その旨を記載する。当面は震度５弱以上と基準とし、震度５弱以上と推定されるものの震度が未入電となっている観測点について、 “震度５弱以上未入電”と記載する。	1回以上
Body.Comments	JSON	情報の本文に加えて付加的な情報を記載する必要がある場合は、本要素以下に情報を記載する。ヘッダ部の「情報形態」（Head.InfoType）が“取消”の場合、本要素は出現しない。	0回/１回
Body.Comments.Observation	String	津波や緊急地震速報に関する付加的な情報を、固定付加文の形式で記載する。	0回/１回

震源に関する情報

		説明	出現回数
Body	JSON	本情報の量的な詳細内容を記載する	1回
Body.Earthquake	JSON	地震の諸要素（発生日時、震央地名、震源要素、マグニチュード等）を記載する。ヘッダ部の「情報形態」（Head.InfoType）が“取消”の場合、本要素は出現しない。	0回/1回
Body.Earthquake.OriginTime	String	地震の発生した時刻を記載する。	1回
Body.Earthquake.ArrivalTime	String	観測点で地震を検知した時刻（発現時刻）を記載する。ただし、国外で発生した地震で発現時刻が不明の場合、「地震発生時刻」（Body.Earthquake.OriginTime）の値を記載する。	1回
Body.Earthquake.Hypocenter	JSON	地震の位置に関する要素（震央地名、震源要素等）を記載する。	1回
Body.Earthquake.Hypocenter.Name	String	震央地名を記載する。	1回
Body.Earthquake.Hypocenter.Code	String	震央地名に対応するコードを記載する。	1回
Body.Earthquake.Hypocenter.Depth	String	深さをメートル単位で記載する。記載する深さの値は、深さ 700km より浅いところでは 10,000 メートルの単位で有効である。	1回
Body.Earthquake.Hypocenter.Longitude	String	震源の経度を記載する。	1回
Body.Earthquake.Hypocenter.Latitude	String	震源の緯度を記載する。	1回
Body.Earthquake.Hypocenter.Coordinate	String	震源要素を記載する。	1回
Body.Earthquake.Magnitude	String	地震のマグニチュードの値を記載する。マグニチュードが不明の場合やマグニチュードが 8 を超える巨大地震と推定される場合は、NaNと記載される。	1回
Body.Earthquake.Magnitude_description	String	地震のマグニチュードの文字列表現を記載する。マグニチュードが不明の場合は、”Ｍ不明”と記載される。マグニチュードが 8 を超える巨大地震と推定される場合は、”Ｍ８を超える巨大地震”と記載される。	1回
Body.Comments	JSON	情報の本文に加えて付加的な情報を記載する必要がある場合は、本要素以下に情報を記載する。ヘッダ部の「情報形態」（Head.InfoType）が“取消”の場合、本要素は出現しない。	0回/１回
Body.Comments.Observation	String	津波や緊急地震速報に関する付加的な情報を、固定付加文の形式で記載する。	0回/１回

震度速報

		説明	出現回数	値
Body	JSON	本情報の量的な詳細内容を記載する	1回
Body.Intensity	JSON	震度に関する情報を記載する。ヘッダ部の「情報形態」（Head.InfoType）が“取消”の場合、本要素は出現しない。	0回/1回
Body.Intensity.Observation	JSON	震度の観測に関する諸要素を記載する。	1回
Body.Intensity.Observation.MaxInt	String	本情報で発表する最大の震度を記載する。	1回	3 / 4 / 5- / 5+ / 6- / 6+ / 7
Body.Intensity.Observation.Pref	Array	都道府県毎の震度の観測状況を記載する。震度を観測した都道府県の数に応じて、本要素が複数出現する。子要素 Name に都道府県名を記載し、対応するコードを子要素 Code に記載する。	1回以上
Body.Intensity.Observation.Pref.MaxInt	String	当該都道府県における最大震度を記載する。	1回	3 / 4 / 5- / 5+ / 6- / 6+ / 7
Body.Intensity.Observation.Pref.Area	Array	地域毎の震度の観測状況を記載する。震度を観測した地域の数に応じて、本要素が複数出現する。子要素 Name に地域名を記載し、対応するコードを子要素Code に記載する。	1回以上
Body.Intensity.Observation.Pref.Area.MaxInt	String	当該地域における最大震度を記載する。	1回	3 / 4 / 5- / 5+ / 6- / 6+ / 7
Body.Comments	JSON	情報の本文に加えて付加的な情報を記載する必要がある場合は、本要素以下に情報を記載する。ヘッダ部の「情報形態」（Head.InfoType）が“取消”の場合、本要素は出現しない。	0回/１回
Body.Comments.Observation	String	津波や緊急地震速報に関する付加的な情報を、固定付加文の形式で記載する。	0回/１回

注意

情報発表後できるだけ早く処理をするようにしておりますが、受信失敗・回線混雑・サーバーメンテナンス・不具合・処理の遅延等で正常に配信ができない、アクセスが出来ない場合があります。ご了承ください。
また、本APIは予告なく配信を停止する場合があります。
本APIを利用することによって生ずるいかなる損害に対しても一切責任を負いません。

この記事は、地震火山関連 XML 電文解説資料を参考にして制作しております。