エラーの種類によって、次の http response を返します。 (エラーメッセージの内容以外は API, method によらず同じです)
400エラーの場合は原則としてエラーメッセージがテキストで返されます。
400 : パラメータエラー等のリクエスト内容に起因するエラー
403 : 認証エラー(有効でない認証トークン)
500 : システム内部エラー(API内部での処理エラー:エネがえる担当者にご連絡ください)
504 : タイムアウト(再実行しても改善されない場合、エネがえる担当者にご連絡ください)
/xxxx
400
403
500
504
/xxxx
400
403
500
504
/xxxx
400
403
500
504
/xxxx
400
403
500
504
[補助金情報の取得]
/sys/subsidy/
※補助金データは月1程度で更新される予定です。(データ更新状況により予定変更の可能性あり)
200
Content-Type: application/json
[
{
"id": "1234567890",
"area": "北海道・東北など",
"title": "ゼロカーボン・ビレッジ構築支援事業",
"url": "例:https://www.pref.hokkaido.lg.jp/kz/kke/108007.html",
"city": "北海道など",
"class": "脱炭素など",
"facility": [
"太陽光発電など"
],
"overview": "補助金概要をご説明します。",
"phone": "担当部署の連絡先をご案内します。",
"prefecture": "東京都など",
"price": "補助金の上限をご案内します。",
"rep": "担当部署をご案内します。",
"modified_id": "U00000000",
"modified": "2019-01-24T06:17:49.811Z",
"created_id": "U00000000000",
"created": "2019-01-24T06:17:49.811Z"
}
]
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "補助金ID"
},
"area": {
"type": "string",
"description": "地域区分"
},
"title": {
"type": "string",
"description": "補助タイトル"
},
"url": {
"type": "string",
"description": "問い合わせ先URL"
},
"city": {
"type": "string",
"description": "市区町村(県含む)"
},
"class": {
"type": "string",
"description": "補助区分"
},
"facility": {
"type": "array",
"description": "対象設備"
},
"overview": {
"type": "string",
"description": "補助金概要"
},
"phone": {
"type": "string",
"description": "問い合わせ先電話番号"
},
"prefecture": {
"type": "string",
"description": "都道府県"
},
"price": {
"type": "string",
"description": "補助額上限"
},
"rep": {
"type": "string",
"description": "問い合わせ先部署"
},
"modified_id": {
"type": "string",
"description": "最終更新者"
},
"modified": {
"type": "string",
"description": "最終更新日時"
},
"created_id": {
"type": "string",
"description": "作成者"
},
"created": {
"type": "string",
"description": "作成日時"
}
}
}
}
/sys/epcorps{?prefecture_cd,zip_cd,area_cd,unlimited}
電気事業者の一覧を取得します。
(prefecture_cd, zip_cd, area_cd は同時に指定できません。)
無制限出力を指定しない場合は、企業管理者がユーザーの所属グループに設定した事業者に制限されます。
*都道府県コード
北海道 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:沖縄県
*エリアコード
01:北海道電力管内
02:東北電力管内
03:東京電力エナジーパートナー管内
04:北陸電力管内
05:中部電力ミライズ管内
06:関西電力管内
07:中国電力管内
08:四国電力管内
09:九州電力管内
10:沖縄電力管内
*fitprices の配列の内容は次のとおり
string
(optional) Example: 13都道府県コード(01~47)
string
(optional) Example: 1000005郵便番号(ハイフンなし, 7桁)
string
(optional) Example: 1エリアコード
number
(optional) Example: 0無制限出力の指定(1:無制限)
200
[
{
"epcorp_cd": "4",
"epcorpName": "東京電力エナジーパートナー",
"eptype": 1,
"area_cd": "03",
"fitprices": [
16
],
"commission": 100,
"occtoepcorp_cd": "K003",
"metiepcorp_cd": "A0269",
"occto_cd": "4203"
}
]
{
"type": "array",
"items": {
"type": "object",
"properties": {
"epcorp_cd": {
"type": "string",
"description": "電気事業者コード"
},
"epcorpName": {
"type": "string",
"description": "電気事業者名"
},
"eptype": {
"type": "number",
"description": "1:旧一電、0:それ以外"
},
"area_cd": {
"type": "string",
"description": "エリアコード"
},
"fitprices": {
"type": "array",
"items": {
"type": "number"
},
"description": "余剰売電単価"
},
"commission": {
"type": "number",
"description": "エリアプライス手数料"
},
"occtoepcorp_cd": {
"type": "string",
"description": "広域機関システムコード"
},
"metiepcorp_cd": {
"type": "string",
"description": "エネ庁登録番号"
},
"occto_cd": {
"type": "string",
"description": "(string) 広域機関スイッチングコード"
}
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}
/sys/epplans/{?epcorp_cd,contractType}
電気事業者コードより電気料金プランを取得します。
number
(required) Example: 4電気事業者コード
number
(optional) Example: 1契約種別 (1: 低圧電灯, 2: 低圧電力, 3: 高圧, 4: 特別高圧)
200
[
{
"epplan_id": "0004_1_0001",
"epcorp_cd": 4,
"contractType": 1,
"epplanType": 1,
"epplanName": "従量電灯B",
"planSuffix": "A",
"periodFrom": "2001-01-01",
"periodTo": "2999-12-31",
"discountRate": 0,
"holidayflg": "011",
"bases": [
{
"base_cd": 3,
"baseName": "従量電灯B(10A)",
"baseType": 1,
"ampere": 10,
"capacityFrom": 0,
"capacityTo": 0
}
]
}
]
{
"type": "array",
"items": {
"type": "object",
"properties": {
"epplan_id": {
"type": "string",
"description": "料金プランID"
},
"epcorp_cd": {
"type": "number",
"description": "電気事業者コード"
},
"contractType": {
"type": "number",
"description": "契約種別 (1:低圧電灯, 2:低圧電力, 3:高圧, 4:特別高圧)"
},
"epplanType": {
"type": "number",
"description": "料金タイプ (1:従量制, 2:市場連動型, 3:従量可変型)"
},
"epplanName": {
"type": "string",
"description": "料金プラン名称"
},
"planSuffix": {
"type": "string",
"description": "契約容量の単位( 'A', 'kVA', 'kW')"
},
"periodFrom": {
"type": "string",
"description": "開始日"
},
"periodTo": {
"type": "string",
"description": "終了日"
},
"discountRate": {
"type": "number",
"description": "総割引率"
},
"holidayflg": {
"type": "string",
"description": "休日フラグ (xyz - x: 土曜, y:日曜, z:祝日、0:平日, 1:休日)"
},
"bases": {
"type": "array",
"items": {
"type": "object",
"properties": {
"base_cd": {
"type": "number",
"description": "基本料金コード"
},
"baseName": {
"type": "string",
"description": "基本料金名称"
},
"baseType": {
"type": "number",
"description": "基本料金計算方法"
},
"ampere": {
"type": "number",
"description": "アンペア (単位 A)"
},
"capacityFrom": {
"type": "number",
"description": "契約容量下限値(以上) (単位:kW or kVA)"
},
"capacityTo": {
"type": "number",
"description": "契約容量上限値(未満) (単位:kW or kVA) 容量制限なしの場合 0"
}
}
}
}
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}
/sys/epplans/{epplan_id}/{base_cd}/{capacity}
料金プランID、基本料金コードより燃調費・再エネ賦課金の単価を含めた詳細情報を取得します。
epplanType=3 (従量可変型) のプランの場合、capacityが必須
料金プラン、燃調費、再エネ賦課金等の単価は最新(実行の前月)のデータを返します。
epplanType=2(市場連動プラン)のプランの場合、計算方法が異なるため、一部のレスポンスは含まれません。
conditions のレコードに group が設定されている場合、同じ groupの対象時間帯の使用量を合算した後、段階制の計算を実行します。
基本料金の計算方法 (base_type)
string
(required) Example: 0004_1_0001料金プランID
number
(required) Example: 3基本料金コード
number
(optional) Example: 3契約容量
200
{
"epplan_id": "0004_1_0001",
"epcorp_cd": 4,
"contractType": 1,
"epplanType": 1,
"epplanName": "従量電灯B",
"periodFrom": "2001-01-01",
"periodTo": "2999-12-31",
"discountRate": 0,
"holidayflg": "110",
"baseName": "従量電灯B(10A)",
"baseType": 1,
"baseUnit": 311.75,
"baseFixUnit": 0,
"ampere": 10,
"capacityFrom": 0,
"capacityTo": 0,
"capacity": 5,
"conditions": [
{
"calcOrder": 1,
"condName": "スタンダードX・第一料金",
"group": 0,
"volumeCap": 0,
"volumeFrom": 0,
"volumeTo": 120,
"monthFrom": 1,
"monthTo": 12,
"holidayData": 0,
"timeFrom": 0,
"timeTo": 0,
"volumeUnit": 29.8
}
],
"fuels": [
{
"calcOrder": 1,
"calcType": 0,
"volumeFrom": 0,
"volumeTo": 0,
"volumeUnit": -9.21
}
],
"renewable": 1.4
}
{
"type": "object",
"properties": {
"epplan_id": {
"type": "string",
"description": "料金プランID"
},
"epcorp_cd": {
"type": "number",
"description": "電気事業者コード"
},
"contractType": {
"type": "number",
"description": "契約種別 (1: 低圧電灯, 2: 低圧電力, 3: 高圧, 4: 特別高圧)"
},
"epplanType": {
"type": "number",
"description": "料金タイプ (1:従量制, 2:市場連動型, 3:従量可変型)"
},
"epplanName": {
"type": "string",
"description": "料金プラン名称"
},
"periodFrom": {
"type": "string",
"description": "開始日"
},
"periodTo": {
"type": "string",
"description": "終了日"
},
"discountRate": {
"type": "number",
"description": "総割引率"
},
"holidayflg": {
"type": "string",
"description": "休日フラグ (xyz - x: 土曜, y:日曜, z:祝日、0:平日, 1:休日)"
},
"baseName": {
"type": "string",
"description": "基本料金名称"
},
"baseType": {
"type": "number",
"description": "基本料金計算方法"
},
"baseUnit": {
"type": "number",
"description": "基本料金単価1"
},
"baseFixUnit": {
"type": "number",
"description": "基本料金単価2"
},
"ampere": {
"type": "number",
"description": "アンペア"
},
"capacityFrom": {
"type": "number",
"description": "契約容量下限値(以上) (単位:kW)"
},
"capacityTo": {
"type": "number",
"description": "契約容量上限値(未満) (単位:kW) 容量制限なしの場合 0"
},
"capacity": {
"type": "number",
"description": "契約容量 (epplan_type=3の場合のみ)"
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"calcOrder": {
"type": "number",
"description": "計算順番"
},
"condName": {
"type": "string",
"description": "条件名"
},
"group": {
"type": "number",
"description": "条件グループ (複数条件がグループ化されている場合、1以上の値)"
},
"volumeCap": {
"type": "number",
"description": "電力使用量条件範囲の上限値(単位 %) 上限を越えた使用量を以降の従量条件で計算 ない場合は 0"
},
"volumeFrom": {
"type": "number",
"description": "使用量 From"
},
"volumeTo": {
"type": "number",
"description": "使用量 To 制限なしの場合 0"
},
"monthFrom": {
"type": "number",
"description": "月 From"
},
"monthTo": {
"type": "number",
"description": "月 To"
},
"holidayData": {
"type": "number",
"description": "休日フラグ (0:区別無し 1:平日のみ 2:休日のみ)"
},
"timeFrom": {
"type": "number",
"description": "時間 From"
},
"timeTo": {
"type": "number",
"description": "時間 To"
},
"volumeUnit": {
"type": "number",
"description": "単価"
}
}
},
"description": "従量条件"
},
"fuels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"calcOrder": {
"type": "number",
"description": "計算順番"
},
"calcType": {
"type": "number",
"description": "計算方法 (0:使用量 x 単価, 1:固定料金)"
},
"volumeFrom": {
"type": "number",
"description": "使用量 From"
},
"volumeTo": {
"type": "number",
"description": "使用量 To 制限なしの場合 0"
},
"volumeUnit": {
"type": "number",
"description": "単価"
}
}
},
"description": "燃料調整費"
},
"renewable": {
"type": "number",
"description": "再エネ賦課金単価"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}
/sys/epchargecalc
料金プランと買電量により電気料金を計算します。
契約容量指定のプラン(アンペア契約以外)で baseTypeが 5,6以外のプランの場合、capacityが必須
燃調費・再エネ賦課金は最新(前月)データをすべての月に適用します(noFuels=1を指定した場合、再エネ賦課金のみを適用します)。
purchaseには1年間を超える範囲は設定できません。
purchaseは 60分平均ですが、30分平均のピーク値を用いて基本料金を計算したい場合は年間の
ピーク値を peak_purchaseに指定してください。
with body
Content-Type: application/json
{
"epplan_id": "0004_1_0001",
"base_cd": 3,
"capacity": 5,
"purchase": [
{
"date": "2023-01-01",
"hourlyPowers": [
0.564516
]
}
],
"peak_purchase": 300,
"noFuels": 1,
"detail": 1
}
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"epplan_id": {
"type": "string",
"description": "料金プランID"
},
"base_cd": {
"type": "number",
"description": "基本料金コード"
},
"capacity": {
"type": "number",
"description": "契約容量"
},
"purchase": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "対象日"
},
"hourlyPowers": {
"type": "array",
"items": {
"type": "number"
},
"description": "1日の各時間帯買電量 (長さ24の配列 (0:00~23:00))"
}
},
"required": [
"date",
"hourlyPowers"
]
},
"description": "各時間帯買電量の配列(長さ24(0:00~23:00))を日毎に配列にしたもの"
},
"peak_purchase": {
"type": "number",
"description": "年間のピーク値"
},
"noFuels": {
"type": "number",
"description": "1を指定した場合、燃調費を適用しない"
},
"detail": {
"type": "number",
"description": "料金の内訳が必要な場合に '1'をセット"
}
},
"required": [
"epplan_id",
"base_cd",
"purchase"
]
}
200
{
"epcorpName": "東京電力エナジーパートナー",
"epplanName": "従量電灯B",
"baseName": "従量電灯B(50A)",
"yearCharge": 167080,
"monthlyCharges": [
14200
],
"detail": {
"discountRate": 0,
"yearCharge": {
"charge": 142000,
"base": 20000,
"usage": 110000,
"adjust": 2000,
"levy": 10000
},
"monthlyCharges": [
{
"month": "2024-01",
"charge": 14200,
"base": 2000,
"usage": 11000,
"adjust": 200,
"levy": 1000
}
]
}
}
{
"type": "object",
"properties": {
"epcorpName": {
"type": "string",
"description": "事業者名"
},
"epplanName": {
"type": "string",
"description": "料金プラン名"
},
"baseName": {
"type": "string",
"description": "基本料金名称"
},
"yearCharge": {
"type": "number",
"description": "年間電気料金総額"
},
"monthlyCharges": {
"type": "array",
"items": {
"type": "number"
},
"description": "各月電気料金(長さ12(1月~12月)の配列)"
},
"detail": {
"type": "object",
"properties": {
"discountRate": {
"type": "number",
"description": "割引率(%)(charge以外の料金を合計した後、割引率を適用して chargeを算出しています。)"
},
"yearCharge": {
"type": "object",
"properties": {
"charge": {
"type": "number",
"description": "電気料金"
},
"base": {
"type": "number",
"description": "基本料金"
},
"usage": {
"type": "number",
"description": "従量料金"
},
"adjust": {
"type": "number",
"description": "燃料調整費"
},
"levy": {
"type": "number",
"description": "再エネ賦課金"
}
},
"description": "年間電気料金"
},
"monthlyCharges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"month": {
"type": "string",
"description": "対象データ"
},
"charge": {
"type": "number",
"description": "電気料金"
},
"base": {
"type": "number",
"description": "基本料金"
},
"usage": {
"type": "number",
"description": "従量料金"
},
"adjust": {
"type": "number",
"description": "燃料調整費"
},
"levy": {
"type": "number",
"description": "再エネ賦課金"
}
}
},
"description": "各月電気料金 (長さ12(1月~12月)の配列)"
}
},
"description": "detail=1 がセットされた場合に追加"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}
/sys/areaprices/{area_cd}
市場連動プランに用いるエリアプライス単価取得
実行時の前月以前の 12か月分の単価を返します。
area_cd
01: 北海道エリア
02: 東北エリア
03: 東京エリア
04: 北陸エリア
05: 中部エリア
06: 関西エリア
07: 中国エリア
08: 四国エリア
09: 九州エリア
string
(optional) Example: 01エリアコード
200
Content-Type: application/json
[
{
"area_cd": "01",
"yearmonth": "2023-01",
"prices": [
10.02
]
}
]
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"area_cd": {
"type": "string",
"description": "エリアコード"
},
"yearmonth": {
"type": "string",
"description": "対象年月"
},
"prices": {
"type": "array",
"items": {
"type": "number"
},
"description": "時間ごとの単価 (長さ 24 の配列 (0時~23時))"
}
}
}
}
Generated by aglio on 17 Sep 2024