震災関連情報
電気予報API
Version 1
リクエストURL
XML
PHPSerialize
JSON
http://setsuden.yahooapis.jp/v1/Setsuden/electricPowerForecast
電力会社からのデータ提供終了に伴って、関西電力(2011年9月21日に更新休止)と中部電力(2011年9月30日に更新休止)のデータ提供が更新休止となりましたのでご注意ください。
電力の最大供給量と使用量を予測値を取得できるAPIです。
現在は東京電力、東北電力、関西電力、中部電力、九州電力管轄内のデータを取得できます。
※電気予報(ベータ版)は、各電力会社発表の電気使用状況の情報と、日本気象協会の気象データをもとに、Yahoo! JAPANが独自の集計で算出した、今後の電力使用率の推測値です。また、供給電力量は各電力提供の最新データを元に計算しておりますので、予測値に関しては実際の値とは異なることがあります。
※関西電力は電力会社からのデータ提供が終了するため、2011/9/21(木)で更新を休止しました。
※中部電力は電力会社からのデータ提供が終了するため、2011/9/30(金)で更新を休止しました。
※更新休止中の電力会社は、データ提供が再開した場合、APIの更新を再開することがあります。
※電気予報APIは期間限定のAPIになります。終了日は未定ですが、決まり次第、掲載します。
※管轄区域の方は節電および計画停電にご協力ください。
リクエストパラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| appid (必須) |
string | アプリケーションID。詳細はアプリケーションIDのヘルプをご覧ください。 |
| output | enum (xml, php, json) デフォルト:xml |
出力形式を指定します。省略した場合、XML形式となります。 |
| callback | string デフォルト:(なし) |
output=jsonを指定した場合、このパラメータを指定するとレスポンスがJSONP形式になります。callback関数名を指定します。 |
| area | enum (tokyo) デフォルト: tokyo |
対象地域です。 tokyo(東京電力管轄内) tohoku(東北電力管轄内) kansai(関西電力管轄内) chubu(中部電力管轄内) 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のレスポンス例
エラー
このAPIは、Yahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。
利用制限
このAPIは、24時間中1アプリケーションIDにつき50000件のリクエストが上限となっています。詳しくは「利用制限」をご参照ください。