電力使用状況API
お知らせ
- 2016年7月25日
- 東北電力、中部電力の電力使用状況APIの更新停止のお知らせ
- 2016年7月19日
- 「電気使用状況API」サービス終了のお知らせ
2016年09月30日（金）をもちまして提供終了させていただきました。
ご利用中の皆様にはおわび申しあげますとともにこれまでのご愛顧に感謝いたします。
データ提供している電力会社は、節電・停電ページで電力使用状況のメーターが更新されている電力会社のみです。メーターが更新されていない電力会社は、電力使用状況の実績値の提供を中止しています。
電力の最大供給量と使用量を取得できるAPIです。
現在は北海道電力、東北電力、東京電力、中部電力、関西電力、九州電力管轄内のデータを取得できます。
1時間ごとの電力使用状況の平均値が取得できます。
※情報提供：北海道電力、東北電力、東京電力、中部電力、関西電力、九州電力
※更新休止中の電力会社は、データ提供が再開した場合、APIの更新を再開することがあります。
※電力使用量APIは期間限定のAPIになります。終了日は未定ですが、決まり次第、掲載します。
※管轄区域の方は節電および計画停電にご協力ください。
※各電力会社の情報開示内容が変更になった場合、本APIの仕様も予告なく変更になる場合があります。
以下の電力会社ではlatestパラメータをつけると、数分間隔に更新されるより最新の電気使用量を取得できるようになりました。更新間隔の目安は以下になります。
| 電力会社 | 更新間隔の目安 |
|---|---|
| 北海道電力 | 1時間更新 |
| 東北電力 | 5分更新 |
| 東京電力 | 5分更新 |
| 中部電力 | 5分更新 |
| 関西電力 | 3分更新 |
| 九州電力 | 5分更新 |
※利用にはアプリケーションIDが必要です。
リクエストパラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| 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（九州電力管轄内） |
| datetime | YYYYMMDDHH | 集計対象となる日時です。省略すると最新のデータを返します。 |
| latest | integer(0,1） デフォルト：0 |
latest=1を指定した場合、最新の使用電力をより短い更新間隔で取得することができます。 ・対応している電力会社 tohoku（東北電力管轄内） tokyo（東京電力管轄内） chubu（中部電力管轄内） kansai（関西電力管轄内） kyushu（九州電力管轄内） |
サンプルリクエストURL
東京電力管轄内の最新の電力使用状況を取得する場合
http://setsuden.yahooapis.jp/v1/Setsuden/latestPowerUsage?appid=＜あなたのアプリケーションID＞ &area=tokyo
東京電力管轄内の2011年6月1日14時台を平均した電力使用状況を取得する場合
http://setsuden.yahooapis.jp/v1/Setsuden/latestPowerUsage?appid=＜あなたのアプリケーションID＞ &area=tokyo&datetime=2011060114
東北電力管轄内の5分間隔で更新される最新の電力使用状況を取得する場合
http://setsuden.yahooapis.jp/v1/Setsuden/latestPowerUsage?appid=＜あなたのアプリケーションID＞ &area=tohoku&latest=1
レスポンスフィールド
| フィールド | 説明 |
|---|---|
| ElectricPowerUsage | ルートノードです。以下のノードを含みます。 |
| フィールド | 説明 |
|---|---|
| Area | 地域です。 |
| Usage | 電力使用量です。
|
| Capacity | 最大供給量です。
|
| Date | 集計対象日です。 |
| Hour | 集計対象時（24時間表記）です。 |
| Min | 集計対象分です。リクエストパラメータでlatest=1を指定した場合のみ、このフィールドを返します。 |
サンプルレスポンス
XMLのレスポンス例
<?xml version="1.0" encoding="UTF-8"?> <ElectricPowerUsage xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="urn:yahoo:jp:setsuden:latestPowerUsage" xsi:schemaLocation="yahoo:jp:setsuden:latestPowerUsage http://setsuden.yahooapis.jp/v1/Setsuden/latestPowerUsage.xsd"> <Area>tokyo</Area> <Usage unit="kW">34100000</Usage> <Capacity unit="kW">38500000</Capacity> <Date>2011-02-13</Date> <Hour>15</Hour> </ElectricPowerUsage>
エラー
このAPIは、Yahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。
利用制限
このAPIは、24時間中1アプリケーションIDにつき50000件のリクエストが上限となっています。詳しくは「利用制限」をご参照ください。
