震災関連情報
電気予報API
お知らせ
- 2014年9月8日
- 「災害ボランティア検索API」「電気予報API」サービス終了のお知らせ
リクエストURL
XML
http://setsuden.yahooapis.jp/v1/Setsuden/electricPowerForecast
PHPSerialize
http://setsuden.yahooapis.jp/v1/Setsuden/electricPowerForecast
JSON
http://setsuden.yahooapis.jp/v1/Setsuden/electricPowerForecast
2015年10月28日（水）をもちまして提供終了させていただきました。
ご利用中の皆様にはおわび申しあげますとともにこれまでのご愛顧に感謝いたします。
データ提供している電力会社は、節電・停電ページで電力使用状況のメーターが更新されている電力会社のみです。メーターが更新されていない電力会社は、電力使用状況の実績値の提供を中止しています。
電力の最大供給量と使用量を予測値を取得できるAPIです。
現在は北海道電力、東北電力、東京電力、中部電力、関西電力、九州電力管轄内のデータを取得できます。
※電気予報は、各電力会社発表の電気使用状況の情報と、日本気象協会の気象データをもとに、Yahoo! JAPANが独自の集計で算出した、今後の電力使用率の推測値です。また、供給電力量は各電力提供の最新データを元に計算しておりますので、予測値に関しては実際の値とは異なることがあります。
※更新休止中の電力会社は、データ提供が再開した場合、APIの更新を再開することがあります。
※電気予報APIは期間限定のAPIになります。終了日は未定ですが、決まり次第、掲載します。
※管轄区域の方は節電および計画停電にご協力ください。
リクエストパラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| appid （必須） |
string | アプリケーションID。詳細はアプリケーションIDのヘルプをご覧ください。 |
| output | enum (xml, php, json) デフォルト：xml |
出力形式を指定します。省略した場合、XML形式となります。 |
| callback | string デフォルト：（なし） |
output=jsonを指定した場合、このパラメータを指定するとレスポンスがJSONP形式になります。callback関数名を指定します。 |
| area | enum (tokyo) デフォルト： tokyo |
対象地域です。 hokkaido（北海道電力管轄内） tohoku（東北電力管轄内） tokyo（東京電力管轄内） chubu（中部電力管轄内） kansai（関西電力管轄内） kyushu（九州電力管轄内） |
| date | YYYYMMDD | 集計対象となる日です。dateを指定した場合、startとresultsは無効になります。 |
| results | integer デフォルト:10 最大:169 |
返却結果の数です。 |
| start | integer デフォルト:1 最大:169 |
返却結果の先頭位置です。 |
サンプルリクエストURL
東京電力管轄内の直近の電気予報を取得する場合
http://setsuden.yahooapis.jp/v1/Setsuden/electricPowerForecast?appid=＜あなたのアプリケーションID＞東北電力管轄内の直近の電気予報を取得する場合
http://setsuden.yahooapis.jp/v1/Setsuden/electricPowerForecast?appid=＜あなたのアプリケーションID＞&area=tohoku九州電力管轄内の8月10日の電気予報を取得する場合
http://setsuden.yahooapis.jp/v1/Setsuden/electricPowerForecast?appid=＜あなたのアプリケーションID＞&area=kyushu&date=20110815レスポンスフィールド
| フィールド | 説明 |
|---|---|
| ElectricPowerForecasts | ルートノードです。以下のノードを含みます。
|
| フィールド | 説明 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| CurrentTime | サーバーのタイムスタンプです。 | ||||||||||
| UpdateTime | データの更新時間です。 | ||||||||||
| Forecast | 各個別のレスポンスを含みます。
|
サンプルレスポンス
XMLのレスポンス例
<?xml version="1.0" encoding="UTF-8"?>
<ElectricPowerForecasts xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="urn:yahoo:jp:setsuden:electricPowerForecast" xsi:schemaLocation="yahoo:jp:setsuden:electricPowerForecast http://setsuden.yahooapis.jp/v1/Setsuden/electricPowerForecast.xsd" totalForecastsAvailable="169" totalForecastsReturned="2" firstForecastsPosition="1">
<CurrentTime>2011-04-21T20:00:55+09:00</CurrentTime>
<UpdateTime>2011-04-21T20:02:03+09:00</UpdateTime>
<Forecast>
<Area>Tokyo</Area>
<Usage unit="kW">352200000</Usage>
<Capacity unit="kW">41000000</Capacity>
<Date>2011-04-21</Date>
<Hour>18</Hour>
</Forecast>
<Forecast>
<Area>Tokyo</Area>
<Usage unit="kW">353400000</Usage>
<Capacity unit="kW">41000000</Capacity>
<Date>2011-04-21</Date>
<Hour>19</Hour>
</Forecast>
</ElectricPowerForecasts>
エラー
このAPIは、Yahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。
利用制限
このAPIは、24時間中1アプリケーションIDにつき50000件のリクエストが上限となっています。詳しくは「利用制限」をご参照ください。
