太陽光発電量API・蓄電池効果API・オール電化効果API・電気料金API・ガス料金APIを全て使える国内唯一のエネがえるAPIとは?

太陽光発電量API・蓄電池効果API・オール電化効果API・電気料金API・ガス料金APIを全て使える国内唯一のエネがえるAPIとは?

エネがえるBLOG

太陽光API・蓄電池API・オール電化API・電気料金API・ガス料金APIを全て使える国内唯一のエネがえるAPIとは?

エネがえるAPIは、加速する地域脱炭素や分散型エネルギー社会において大企業を中心に採用が急増しているエネルギー診断APIサービスです。

太陽光発電量推計API・蓄電池効果API・オール電化効果API・電気料金API(料金プランAPI)・都市ガスAPI(料金プランAPI)など多様なエネルギー診断APIを用いて、独自システムやWebサイト・アプリ開発が可能です。しかも、面倒で複雑な料金プランのメンテナンスや製品情報メンテナンスから解放されるため、運用保守コスト低減にも繋がります。

エネがえるAPIサービス概要は以下をご参照ください。

●エネがえるAPIサービスがよく使われる8つの導入事例・ユースケースは?

1)小売電力事業者のWeb電気料金シミュレーション(電気・都市ガス・オール電化プラン用)

2)Bルート等の電気消費量実データ連携の電気使いすぎアラートアプリ

3)太陽光・蓄電池メーカーのWeb太陽光・蓄電池経済効果シミュレーション

4)太陽光・蓄電池商社の販売会社支援向け創蓄連携提案ツール

5)蓄電池メーカーのAI蓄電池充放電最適制御及び蓄電池導入効果見える化

※その他、非公開事例として蓄電池メーカーやHEMSメーカーの電力消費量実データ連携の最適料金プラン診断
などなど。多様なユースケースや事例がございます。

●エネがえるAPIでできる機能(公開用のみ)は?

これ以外の非公開APIもご用意しております。
発電量予測・需要予測関連のAPI、気象予測・警報関連のAPI、電力消費量実データと連携するAPIなどなど。

ご要望に応じた追加開発(個別見積)もしております。ご相談ください。

●エネがえる V4 一般公開用API
https://www-v4.enegaeru.com/apidoc/api-general.html

ログイン・ログアウト、単機能のシミュレーション、料金計算など基本的なAPIをご提供します。
ログ用の最低限のデータを除き、APIによる計算結果は エネがえるのシステム側には残りません。
ある条件下での電気料金等の計算は シミュレーションの結果をもとに料金計算を実行するなど、複数の API を組み合わせて実装できます。

効果額は 条件の異なる複数のシミュレーション&料金計算の結果を比較することで実装できます。

なお、各APIの記述にある Request Body のサンプルは簡略化されており、このとおりにパラメータをセットしてもエラーが発生します。Request Schema にパラメータの詳細を記述していますので、こちらの内容に従って APIのパラメータをセットして呼び出してください。

●エネがえるAPI利用の最初のステップ、利用例

・使い方などは、はじめにドキュメントをご参照ください。
https://www-v4.enegaeru.com/apidoc/index.html

●エネがえるAPI機能一覧(公開用のみ)

※電力消費量実データと連携できる非公開APIもございます。ご相談ください。

シミュレーション関連のAPI



▼電気使用量計算API(/usepowercalc/)

-現在の電気使用量(kWh)、居住地、生活パターンテンプレート(ロードカーブのテンプレート)により現在使っている電気使用量(kWh)を1時間値で推計します。
-エネがえるでは、最低1ヶ月~最大12ヶ月分の電気使用量(kWh)を指定することで、月別・時間別の電気消費量(kWh)を推計します。時間帯別料金プランやオール電化プランにも対応しています。
※生活パターンテンプレートは、テンプレートID(1:朝型, 2:昼型, 3:夜型, 4:オール電化型, -1:カスタム)から指定ができる。(以下Schema参照)

Schema:

{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"prefectures_cd": {
"type": "string",
"description": "都道府県コード"
},
"template_id": {
"type": "number",
"description": "テンプレートID(1:朝型, 2:昼型, 3:夜型, 4:オール電化型, -1:カスタム)"
},
"timeperiod": {
"type": "array",
"items": {
"type": "object",
"properties": {
"from": {
"type": "number",
"description": "時間帯(from)"
},
"to": {
"type": "number",
"description": "時間帯(to)"
},
"ratio": {
"type": "number",
"description": "電力量割合 (%)"
}
},
"required": [
"from",
"to",
"ratio"
]
},
"description": "時間帯別電力量割合 (template_id=-1の場合必要, それ以外は指定不可)"
},
"average_epower": {
"type": "number",
"description": "月平均の電気使用量"
},
"epowers": {
"type": "array",
"items": {
"type": "number"
},
"description": "各月の電気使用量 (長さ12の配列 (1月~12月))"
}
},
"required": [
"prefectures_cd",
"template_id"
]
}


▼日射量観測地点取得API(/sunpoints/{?prefectures_cd})
-都道府県コードより日射量観測地点を取得します。
-太陽光発電量(kWh)推計に用います。参照する日射量データベースは、NEDO METPV20となります。
-都道府県コードについては、別途 電気事業者取得(/epcorps) API を参照ください。

▼太陽光発電量計算API(/pvpowercalc/)
-設置地点、太陽光パネル情報から太陽光発電量を計算します。
-PCS変換効率、設置形態(架台設置、屋根置き、建材一体)、基本設計係数、方位角、傾斜角、出力値などきめ細かな設定ができます。

▼太陽光・蓄電池シミュレーションAPI(/pvcellsimulation/)
-電気使用量(kWh)、太陽光発電量(kWh)、蓄電池情報(製品情報)、蓄電池売電モード(余剰売電/全量売電)、蓄電の優先順位(自家消費優先/売電優先)から日々の使用推移のシミュレーションを行います。

▼既設太陽光発電シミュレーションAPI(/pvinstalledcalc/)
-既設太陽光の買電量からシミュレーションを実行します。
-太陽光が設置済みのFIT期間中(または卒FIT)の世帯に蓄電池やオール電化を設置提案するシミュレーションなどでご利用いただけます。

▼ガス使用量計算API(/usegascalc/)
-現在のガス使用量(m3)、世帯人数、使用ガス機器等により月毎のガス使用量(m3)を推計します。
-都市ガスの切り替え提案はもちろん、ガス併用の世帯にオール電化切り替え提案をするシミュレーションなどでご利用いただけます。

▼オール電化シミュレーションAPI(/aesimulation/)
-オール電化のシミュレーションを実行します。
-ガス併用の世帯にオール電化切り替え提案をするシミュレーションなどでご利用いただけます。

▼電気使用量計算(電気料金から)API(/useepchargecalc/)
-現在の居住地、生活パターンテンプレート、電気料金プラン、電気料金により電気使用量を推計します。
-電気料金(円)から電気使用量(kWh)を逆算できるAPIです。従量電灯を想定すると機能しますが、オール電化や時間帯別料金プランの場合は
大きな誤差が生じるリスクがあるため、シミュレーションのUIUX・画面遷移を含めた実装の際の工夫が必要となります。


蓄電池API・エコキュートAPI(機器マスター関連のAPI)

機器マスター関連のAPI.PNG

▼蓄電システム製品情報API(/cells{?unlimited})
-蓄電システム製品の情報を取得します。
-エネがえるでは、国内98%以上の家庭用蓄電システム主要メーカー・製品をカバーしています。
(※追加希望の家庭用蓄電システム製品がある場合は、API契約者からのご要望であれば約1ヶ月で追加いたします。)


Body:
[
{
"id": 32,
"maker": "DMM",
"model": "MS3098-DM",
"name": "【DMM】DMM.make smart(9.8kWh)",
"cell_capacity": 6.5,
"rated_capacity": 2.2,
"charge_time": 6,
"charge_depth": 90,
"discharge_depth": 0,
"push_up": 0,
"charge_from": 23,
"charge_to": 5,
"discharge_from": 5,
"discharge_to": 23,
"charge_from_a": 23,
"charge_to_a": 5,
"discharge_from_a": 5,
"discharge_to_a": 23,
"use_pv_overloaded": 1,
"twocycle_default": 1
}
]

Schema:

{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "蓄電池ID"
},
"maker": {
"type": "string",
"description": "メーカー名"
},
"model": {
"type": "string",
"description": "モデル"
},
"name": {
"type": "string",
"description": "蓄電池名称"
},
"cell_capacity": {
"type": "number",
"description": "蓄電池容量"
},
"rated_capacity": {
"type": "number",
"description": "定格出力"
},
"charge_time": {
"type": "number",
"description": "充電時間"
},
"charge_depth": {
"type": "number",
"description": "充電深度"
},
"discharge_depth": {
"type": "number",
"description": "放電深度"
},
"push_up": {
"type": "number",
"description": "ダブル発電(0:なし, 1:あり)"
},
"charge_from": {
"type": "number",
"description": "(太陽光なしor売電優先時) 充電可能時間帯 From (系統から)"
},
"charge_to": {
"type": "number",
"description": "(太陽光なしor売電優先時) 充電可能時間帯 To (系統から)"
},
"discharge_from": {
"type": "number",
"description": "(太陽光なしor売電優先時) 放電可能時間帯 From"
},
"discharge_to": {
"type": "number",
"description": "(太陽光なしor売電優先時) 放電可能時間帯 To"
},
"charge_from_a": {
"type": "number",
"description": "(太陽光自家消費優先時) 充電可能時間帯 From (系統から)"
},
"charge_to_a": {
"type": "number",
"description": "(太陽光自家消費優先時) 充電可能時間帯 To (系統から)"
},
"discharge_from_a": {
"type": "number",
"description": "(太陽光自家消費優先時) 放電可能時間帯 From"
},
"discharge_to_a": {
"type": "number",
"description": "(太陽光自家消費優先時) 放電可能時間帯 To"
},
"use_pv_overloaded": {
"type": "number",
"description": "太陽光過積載充電(0:なし, 1:あり)"
},
"twocycle_default": {
"type": "number",
"description": "2サイクル充電デフォルト値(0:OFF, 1:ON)"
}
}
}
}

▼エコキュート製品情報API(/ecocutes{?unlimited})
-エコキュート製品の情報を取得します。
-エネがえるでは、国内98%以上の家庭用エコキュートメーカー・エコキュート製品をカバーしています。
(※追加希望のエコキュート製品がある場合は、API契約者からのご要望であれば約1ヶ月で追加いたします。)

Body:
{
"id": 5,
"maker_code": 1,
"maker_name": "パナソニック",
"category_cd": 1,
"capacity": 370,
"efficiency": 3.8,
"epower": 0.975,
"epower_winter": 1.5,
"epower_save": 0.975,
"epower_winter_save": 1.5
}

Schema:

{
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "エコキュート機器ID"
},
"maker_code": {
"type": "number",
"description": "エコキュート事業者コード"
},
"maker_name": {
"type": "string",
"description": "事業者名"
},
"category_cd": {
"type": "number",
"description": "種別 (スタンダード(標準機):1, プレミアム:2, その他:3)"
},
"capacity": {
"type": "number",
"description": "貯湯容量 (ℓ)"
},
"efficiency": {
"type": "number",
"description": "エネルギー消費効率 (ヒートポンプ給湯器を運転した時の単位消費電力量あたりの給湯熱量および保温熱量)"
},
"epower": {
"type": "number",
"description": "春~秋の消費電力量出力 (kW)"
},
"epower_winter": {
"type": "number",
"description": "冬の消費電力量出力 (kW)"
},
"epower_save": {
"type": "number",
"description": "春~秋の消費電力量出力 (kW) パワーセーブ時"
},
"epower_winter_save": {
"type": "number",
"description": "冬の消費電力量出力 (kW) パワーセーブ時"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}

電気料金関連のAPI

電気料金関連のAPI.PNG

▼電気事業者取得API(/epcorps{?prefectures_cd,zip_cd,unlimited})
-prefectures_cd と zip_cd は同時に指定できません。
(※追加希望の小売電気事業者がある場合は、API契約者からのご要望であれば約1ヶ月で追加いたします。)

*都道府県コード
  北海道 01:北海道
  東北  02:青森県, 03:岩手県, 04:宮城県, 05:秋田県, 06:山形県, 07:福島県
  関東  08:茨城県, 09:栃木県, 10:群馬県, 11:埼玉県, 12:千葉県, 13:東京都, 14:神奈川県
  北陸  15:新潟県, 16:富山県, 17:石川県, 18:福井県
  中部  19:山梨県, 20:長野県, 21:岐阜県, 22:静岡県, 23:愛知県
  近畿  24:三重県, 25:滋賀県, 26:京都府, 27:大阪府, 28:兵庫県, 29:奈良県, 30:和歌山県
  中国  31:鳥取県, 32:島根県, 33:岡山県, 34:広島県, 35:山口県
  四国  36:徳島県, 37:香川県, 38:愛媛県, 39:高知県
  九州  40:福岡県, 41:佐賀県, 42:長崎県, 43:熊本県, 44:大分県, 45:宮崎県, 46:鹿児島県
  沖縄  47:沖縄県

▼電気料金プラン取得API(/epplans{?epcorp_cd})
-電気事業者コードより電気料金プランを取得します。
(※追加希望の電気料金プランがある場合は、API契約者からのご要望であれば約1ヶ月で追加いたします。)

▼対応する電気料金プラン取得API(/extractepplans/)
-指定した電気事業者の料金プランの内、契約アンペア数 または 契約容量に対応する料金プランを取得します。

▼電気料金計算API(/epchargecalc/)
-料金プランと買電量により電気料金を計算します。
-月毎の燃料調整費、再エネ賦課金は basemonthに指定された月以前の同じ月のデータを適用して料金計算します。無指定の場合は燃料調整費を適用しません。
-うるう年は考慮せず、2月は 28日固定として計算します。

▼電気料金診断API(/epdiagnosis/)
-複数の料金プランの電気料金を計算し、ランキングした結果を返します。
-月毎の燃料調整費、再エネ賦課金は basemonthに指定された月以前の同じ月のデータを適用して料金計算します。無指定の場合は燃料調整費を適用しません。
-うるう年は考慮せず、2月は 28日固定として計算します。

Body:
[
{
"epcorp_cd": 4,
"epcorp_shortname": "東京電力エナジーパートナー",
"plan_cd": 5,
"plan_name": "従量電灯B(50A)",
"plan_info": "料金プランの概要",
"yearcharge": 167080,
"monthlycharges": [
"14200"
]
}
]

Shema:
{
"type": "array",
"items": {
"type": "object",
"properties": {
"epcorp_cd": {
"type": "number",
"description": "電気事業者コード"
},
"epcorp_shortname": {
"type": "string",
"description": "事業者名"
},
"plan_cd": {
"type": "number",
"description": "料金コード"
},
"plan_name": {
"type": "string",
"description": "料金プラン名"
},
"plan_info": {
"type": "string",
"description": "料金プランの概要"
},
"yearcharge": {
"type": "number",
"description": "年間電気料金総額"
},
"monthlycharges": {
"type": "array",
"items": {
"type": "string"
},
"description": "各月電気料金 (長さ12の配列 (1月~12月))"
}
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}

都市ガス料金関連のAPI

▼都市ガス事業者取得API(/gcorps/{?prefectures_cd})
-都道府県コードより契約可能な都市ガス事業者を取得します。
(※追加希望の都市ガス事業者がある場合は、API契約者からのご要望であれば約1ヶ月で追加いたします。)

▼都市ガス料金プラン取得API(/gplans{?gcorp_cd})
-都市ガス事業者コードより都市ガス料金プラン(一般契約のみ)を取得します。
(※追加希望の都市ガス料金プランがある場合は、API契約者からのご要望であれば約1ヶ月で追加いたします。)

▼対応する都市ガス料金プラン取得API(/extractgplans/)
-指定した都市ガス事業者の料金プランの内、対応する料金プランを取得します。

▼都市ガス料金計算API(/gaschargecalc/)
-料金プランと使用量によりガス料金を計算します。

▼都市ガス料金診断API(/gasdiagnosis/)
-複数の料金プランのガス料金を計算し、ランキングした結果を返します。

ログイン関連のAPI

ログイン関連.PNG

▼ログインAPI(/login/)
-ユーザーIDとパスワードでシステムにログインします。

▼ログアウトAPI(/logout/)
-システムからログアウトします。

▼ユーザー情報取得API(/userinfo/)
-ログインしているユーザーに関する情報を取得します。

▼ユーザー情報変更API(/userinfo/)
-ログインしているユーザーの設定を変更します。

その他のAPI

▼郵便番号情報取得API(/zipcds/{zip_cd})

-郵便番号の情報(都道府県コード)を取得します。 都道府県コードは 電気事業者API (/epcorps) を参照してください。