1. 概要
各電力会社が提供している電力使用状況「でんき予報」のデータを統一した形で扱うことが出来るAPIです。
利用例
・独自のでんき予報アプリケーションを作成したい
・各電力会社の情報を保存したい
・その他色々
更新 2019/11/21
2. 通信先
XML版: http://norikawa.net/Tools/Japan2011/EPForecast/epsimpleapi.php
JSON版: http://norikawa.net/Tools/Japan2011/EPForecast/epsimpleapi.php?encoding=json
3. 要求パラメータ
パラメータ名 | 意味 | パラメータ指定方法 | 必須/任意 | 備考 |
---|---|---|---|---|
epid | 電力会社ID | GET/POST | 任意 | (*1)を参照 |
(*1) 電力会社ID
epid [電力会社ID] | 詳細 |
---|---|
1 | 北海道電力 |
2 | 東北電力 |
3 | 東京電力(デフォルト値) |
4 | 北陸電力 |
5 | 中部電力 |
6 | 関西電力 |
7 | 中国電力 |
8 | 四国電力 |
9 | 九州電力 |
10 | 沖縄電力 |
4. 応答結果(成功)例 [東北電力の電力使用状況]
<epSimpleUsage status="true">←トップレベル(成功)
<epid>2</epid>←要求電力会社ID(*1)
<companyData>←会社情報
<epid>2</epid>←会社情報(電力会社ID)(*1)
<companyName>東北電力</companyName>←会社情報(電力会社名)
<companyEnglishName>Tohoku Electric Power Co.,Inc.</companyEnglishName>←会社情報(電力会社名英文)
<companyDataURL>http://setsuden.tohoku-epco.co.jp/common/demand/juyo_tohoku.csv</companyDataURL>←会社情報(データ取得URL)
<companyURL>http://setsuden.tohoku-epco.co.jp/graph.html</companyURL>←会社情報(でんき予報URL)
</companyData>
<updateData>←更新情報
<fullDate>2011/7/11</fullDate>←更新情報(更新日付)
<time>17:37</time>←更新情報(更新時刻)
</updateData>
<usageData>←使用量情報
<fullDate>2011/7/11</fullDate>←使用量情報(日付)
<time>17:35</time>←使用量情報(時刻)
<useEp>1099</useEp>←使用量情報(使用量 [万Kw])
<unuseEp>176</unuseEp>←使用量情報(未使用量 [万Kw])
<rate>86.2</rate>←使用量情報(使用率 小数点2桁四捨五入 [%])
</usageData>
<peakData>←ピーク供給量情報
<ep>1275</ep>←ピーク供給量情報(ピーク供給量 [万Kw])
<timeRange>14:00〜15:00</timeRange>←ピーク供給量情報(ピーク時間レンジ)
<date>7/10</date>←ピーク供給量情報(ピーク供給量情報発表日付)
<time>18:02</time>←ピーク供給量情報(ピーク供給量情報発表時刻)
</peakData>
<forecastData>←予想使用量情報
<ep>1170</ep>←予想使用量情報(予想使用量 [万Kw])
<timeRange>14:00〜15:00</timeRange>←予想使用量情報(予想使用量時間レンジ)
<date>7/11</date>←予想使用量情報(予想使用量発表日付)
<time>13:52</time>←予想使用量情報(予想使用量発表日付)
</forecastData>
<versionData>←ヴァージョン情報
<title>Japan electric power forecast simple API</title>←ヴァージョン情報(タイトル)
<version>Ver 1.04</version>←ヴァージョン情報(ヴァージョン)
<build>2011/07/21</build>←ヴァージョン情報(ビルド日時)
<auther>Teruyoshi Norikawa</auther>←ヴァージョン情報(作者)
<homepage>http://norikawa.net/n/</homepage>←ヴァージョン情報(ホームページ)
<email>t.norikawa@gmail.com</email>←ヴァージョン情報(E-Mail)
<twitter>http://twitter.com/tnori</twitter>←ヴァージョン情報(Twitter)
</versionData>
</epSimpleUsage>
5. 結果(失敗)例
<epSimpleUsage status="false">←トップレベル(失敗)
<errorCode>103</errorCode>←エラーコード(*2)
<errorCode>epid disable</errorCode>←エラーコード詳細(*2)
<versionData>←ヴァージョン情報
<title>Japan electric power forecast simple API</title>←ヴァージョン情報(タイトル)
<version>Ver 1.04</version>←ヴァージョン情報(ヴァージョン)
<build>2011/07/21</build>←ヴァージョン情報(ビルド日時)
<auther>Teruyoshi Norikawa</auther>←ヴァージョン情報(作者)
<homepage>http://norikawa.net/n/</homepage>←ヴァージョン情報(ホームページ)
<email>t.norikawa@gmail.com</email>←ヴァージョン情報(E-Mail)
<twitter>http://twitter.com/tnori</twitter>←ヴァージョン情報(Twitter)
</versionData>
</epSimpleUsage>
(*2) エラーコード・エラー詳細
エラーコード | エラーコード詳細 | 備考 |
---|---|---|
1 | data not found | 電力会社のデータが取得できません(電力会社側メンテナンス等の問題) |
2 | data abnormal | 電力会社のデータが不正です(電力会社側データフォーマット変更等) |
3 | internal | 処理ができません(内部処理エラー:よろしければご報告ください) |
101 | epid not found | 電力会社IDパラメータがありません |
102 | epid unknown | 電力会社IDが不正です |
103 | epid disable | この電力会社のでんき予報はありません |
6. 応用例(全国電力使用量)
ホームページ(ブログ)埋め込みコード生成(使用量グラフ) [別ウィンドウで開く]