01 / START HERE
最初に確認する、3つのこと
閲覧は登録不要
メソッド・パス・入力・出力を公開仕様書で確認できます。画面内のYAMLリンクからOpenAPI定義も参照できます。
実行には認証が必要
閲覧とAPI実行は別です。利用する商品、契約プラン、対象オプションを確認してから接続します。
数字の意味まで確認
時間粒度、単位、料金の適用時点をそろえます。設備の電力収支と料金計算を分けると、結果を説明しやすくなります。
メソッド・パラメータ・返却値の詳細は、公式の公開仕様書を参照してください。商品別の提供範囲と公開仕様の掲載範囲は同一ではありません。
02 / API DIRECTORY
必要な処理から、APIを見つける
現行の公開定義に掲載された20のパスを整理しました。/xxxxは共通エラーの説明用パスのため、呼び出し先の一覧から除いています。
20件
| メソッド / パス | できること | 仕様書の分類 |
|---|---|---|
POST/sys/login |
ログイン | ログイン |
GET/sys/logout |
ログアウト | ログイン |
GET/sys/subsidy |
補助金情報一覧(ページング) | 補助金データ照会 |
GET/sys/subsidy/{id} |
補助金情報詳細 | 補助金データ照会 |
GET/sys/subsidy-search |
補助金情報検索(サーバサイド検索・ページ指定) | 補助金データ照会 |
GET/sys/epcorps |
電気事業者取得 | 電気料金プラン関連 |
GET/sys/epplans |
電気料金プラン取得 | 電気料金プラン関連 |
GET/sys/epplans/{epplan_id}/{base_cd}/{capacity} |
電気料金プラン詳細取得 | 電気料金プラン関連 |
POST/sys/epchargecalc |
電気料金計算 | 電気料金プラン関連 |
POST/sys/usepowercalc |
電気使用量計算 | シミュレーション |
POST/sys/pvpowercalc |
太陽光発電量計算 | シミュレーション |
GET/sys/gascorps |
ガス事業者取得 | ガス料金プラン関連 |
GET/sys/gasplans |
ガス料金プラン取得 | ガス料金プラン関連 |
POST/sys/usegascalc |
ガス12ヶ月推計 | ガス→オール電化推計 |
POST/sys/gasconvert |
ガス→電気換算 | ガス→オール電化推計 |
POST/sys/applianceprofile |
エコキュートシミュレーション | ガス→オール電化推計 |
POST/sys/gaschargecalc |
ガス料金計算 | ガス料金計算 |
POST/sys/equipsimulation |
設備導入シミュレーション | シミュレーション |
POST/sys/enefarmsimulation |
エネファーム経済効果シミュレーション | エネファーム |
POST/sys/equipconsumptionest |
電気消費量推定(設備設置済み住宅) | シミュレーション |
一致するAPIがありません。別の言葉か、パスの一部で検索してください。
名称が近いAPIでも入力・出力は異なります。詳細は仕様書の対象操作を開き、SchemaとExample Valueをあわせて確認してください。
03 / AUTHENTICATION
認証から、最初のリクエストまで
- 接続先を確認する。公開仕様の本番ベースURLは
https://api.enegaeru.comです。 - ログインする。
POST /sys/loginにx-api-keyを付け、JSON本文にusernameとpasswordを送ります。productの指定は利用するサービスに合わせて確認します。 - uidを保持する。レスポンスの
uidを、後続リクエストのAuthorizationヘッダーへ直接設定します。公開仕様はBearer方式として定義されていません。 - 対象APIの認証要件を確認する。各操作のSecurityと必要な利用権限を照合し、入力・出力を小さなデータで確認します。
forcelogin=trueは、同じユーザー名で先にログインした利用者のアクセストークンを無効にします。常時指定する前に、同時利用とセッション管理を設計してください。補助金APIを呼び出すcURL例
東京都の太陽光・蓄電池に関する個人向けデータを取得する例です。認証済みのuidとAPIキーを環境変数に設定して使います。ここではAPIを実行しません。
# 認証情報はサーバー側の環境変数で管理します。
# ENEGAERU_UID にはログインレスポンスの uid を設定します。
curl --fail-with-body --get \
'https://api.enegaeru.com/sys/subsidy' \
-H "x-api-key: ${ENEGAERU_API_KEY}" \
-H "Authorization: ${ENEGAERU_UID}" \
--data-urlencode 'prefecture_cd=13' \
--data-urlencode 'facility_cd=01,02' \
--data-urlencode 'target_class=個人' \
--data-urlencode 'limit=20'
一覧レスポンスのnextTokenが返る場合は、次のリクエストへ渡します。制度の金額・期間などはGET /sys/subsidy/{id}の詳細も確認してください。認証情報をWebページのJavaScriptや公開リポジトリへ埋め込まないでください。
Swagger UIの読み方
- 目次から分野を選び、対象メソッド・パスを開く。
- Parameters/Request bodyで必須項目、型、単位、配列長を確認する。
- Responsesで正常系とエラー系のSchema・サンプルを確認する。
- 実行する場合は契約・権限・入力データを確認する。本番環境への実行であることに注意する。
04 / CALCULATION DESIGN
実装が動いた後に、結果の前提をそろえる
電力収支 → 料金
需要データを用意し、pvpowercalcで発電量、equipsimulationで設備導入後の電力収支を計算。買電量を料金計算に接続します。
使用量 → 機器 → 料金
usegascalcなどで入力を整え、applianceprofile等の結果を確認。残るガス使用量と電力の変化を、それぞれ料金へ換算します。
実績 → 消費量推定
equipconsumptionestで月別実績と設備諸元から消費量を推定。利用には対象オプションが必要です。推定結果と実測値は区別します。
上記は処理構成の例です。出力をそのまま次の入力へ渡せるかは、各Schemaのフィールド名・単位・日付・粒度を照合して判断してください。
数値の解釈を変える重要条件
- 太陽光の出力はkW。
pvpowercalcのpanels[].volは1方角あたりの出力です。2026年10月2日にkWhからkWへ表記が訂正されました。入力値・計算結果の変更はありません。 - 市場連動型は30分値。
epchargecalcのday_purchaseは48要素が必要です。前月までの最新12か月のエリアプライスから同じ月を使うため、任意の過去年や将来の市場価格を再現する条件とは区別します。 - 料金単価の時点を記録する。燃料費調整・再エネ賦課金・容量拠出金は、原則として最新(前月)のデータを各月へ適用する仕様です。市場連動プラン、または
noFuels=1では燃料費調整を適用しません。 - 年度をまたぐ賦課金は月別に確認。
renewableUnitsを指定すると月別値を使います。1〜12月の12要素で、null・欠落は不可。renewableより優先されます。燃料費調整はfuelsによる月別指定が可能です。 - 日付と粒度をそろえる。設備導入シミュレーションでは、需要と太陽光発電量の日付対応を確認します。許容期間や配列長は対象APIの定義に従ってください。
- エネファームは料金計算を後続処理へ。
enefarmsimulationの結果から、電気料金・ガス料金APIへ接続する構成です。料金まで一括で返るとは扱わないでください。
本ガイドの推奨設計は、入力データ・設備諸元・料金プランID・単価の適用時点・API応答・計算日時を一緒に保持することです。APIの標準保存機能を示すものではありません。
05 / TROUBLESHOOTING
エラーは、コードと本文をセットで確認
| HTTPステータス | 確認すること |
|---|---|
| 400 リクエスト不正 | 必須項目・型・値の範囲・配列長・日付の対応を確認します。 |
| 401 / 403 認証・利用権限 | 認証情報、uid、契約・オプションを確認します。共通仕様と個別APIで定義が異なるため、対象操作のResponsesを参照します。 |
| 500 内部処理エラー | 発生時刻・パス・機密情報を除いたリクエスト条件と応答を記録し、問い合わせます。 |
| 504 タイムアウト | 処理対象と応答を確認します。再試行方針は操作の性質と利用条件に合わせて決めます。 |
APIによってエラー本文がJSONではなくtext/plainで返る場合があります。すべての応答を無条件にJSONとして解析せず、HTTPステータスとContent-Typeを確認してください。
API利用上限・同時実行・タイムアウト・再試行・商用運用条件は、契約対象の仕様と照合してください。このガイドでは公開定義から確認できない数値を補っていません。
06 / WHAT CHANGED
実装に関係する主な更新
- 2026年10月2日:
pvpowercalcのパネル出力単位をkWへ表記訂正。 - 2026年8月29日:設備設置済み住宅の消費量推定
equipconsumptionestを追加。 - 2026年8月25日:
applianceprofileの暖房パラメータを廃止。残ガスの返却形式をm³へ変更。エネファームAPIを仕様書に掲載。 - 2026年8月19日:ガス事業者・料金プラン取得APIを追加。電気料金関連に容量拠出金の項目を追加。
変更内容の全文と、その後の更新は仕様書冒頭の更新履歴で確認してください。バージョン表示だけで変更の有無を判断せず、利用する操作とSchemaも確認します。
07 / FAQ
API仕様書・連携開発のよくある質問
API仕様書は登録せずに読めますか?
公開仕様書とOpenAPI YAMLは登録せずに閲覧できます。APIの実行には、認証情報と対象機能を利用できる契約・権限が必要です。
APIポータルと仕様書ガイドの違いは?
APIポータルは用途・商品・導入相談の入口です。このガイドは公開仕様書の読み方と実装上の確認事項を整理しています。実装時のパラメータとレスポンスは、リンク先の最新OpenAPI定義を確認してください。
AuthorizationにはBearerを付けますか?
公開仕様では、ログインレスポンスのuidをAuthorizationヘッダーへ直接設定します。Bearer方式とは記載されていません。あわせて、各操作に指定されたx-api-keyなどの認証要件を確認してください。
市場連動型の料金計算には何が必要ですか?
epchargecalcの市場連動プランでは、day_purchaseに1日48要素の買電量配列が必要です。前月までの最新12か月のエリアプライスのうち同じ月のデータを使う仕様です。将来の市場価格の予測値を返すものではありません。
太陽光が設置済みで、消費量がわからない場合は?
equipconsumptionestは設備設置済み住宅の電気消費量を推定するAPIです。未実測月はnullで指定し、配列長は12か月固定、実測は最低1か月必要です。冬・中間期・夏を含む3か月以上が推奨されています。対象オプションが有効な場合に利用できます。
BizやEV・V2Hの全機能がこの仕様書に載っていますか?
公開仕様の掲載範囲と商品別の契約範囲は同一ではありません。公開定義にないエンドポイントを推測せず、用途・必要な入力と出力・想定件数を整理してお問い合わせください。
AIにコード生成を依頼してもよいですか?
公開OpenAPI定義を参照させ、メソッド・パス・必須項目・単位・認証方式を照合する方法が有効です。認証情報や顧客データは入力せず、生成コードは開発者が確認してください。
08 / NEXT STEP
作りたいサービスから、必要なAPIを整理する
用途、手元の入力データ、画面や帳票に出したい結果、想定利用件数をお知らせください。公開仕様の確認から、API導入・PoC・個別開発の進め方まで相談できます。
住宅用太陽光・蓄電池 / 産業用・自家消費 / EV・V2H / 電気料金・補助金 / 市場連動型料金
公式資料・このガイドについて
提供:国際航業株式会社 エネがえる。確認日:2026年10月4日。公開仕様をもとに、実装前の確認順を整理しています。スクリーンショットは同日に撮影しました。



