Skip to content

enechange/emap-api-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 

Repository files navigation

EMAP API README

Plan API

  • Plan APIでは、4つのエンドポイントを提供します。
    • /elec/areas : 電力のエリアを取得できます。
    • /elec/providers : 電気事業者一覧を取得できます。
    • /elec/plans : 低圧の電気料金プランを提供・公開している事業者およびプランを取得できます。
    • /elec/fuel_cost_adjustments : 燃料費調整額を取得できます。
    • /elec/renewable_energy_surcharges : 再生可能エネルギー発電促進賦課金を取得できます。
  • APIの仕様の詳細についてはこちらをご覧ください。

実行例

# curlの場合
curl -H 'X-EMAP-USER-KEY:emapapidemouser1234' 'https://emap-sim-base.enechange.jp/v001/elec/plans' > emap_plans.json

# wgetの場合
wget --header='X-EMAP-USER-KEY:emapapidemouser1234' 'https://emap-sim-base.enechange.jp/v001/elec/plans' -O emap_plans.json

cat emap_plans.json | jq
  • X-EMAP-USER-KEYはデモ用の値となります。ご契約後に正式な値をお伝えいたします。
  • EMAP APIについては以下をご覧ください。

Simulation API

  • APIの仕様の詳細についてはこちらをご覧ください。
  • POSTするJSON例
    • fee_plan_codeは電気料金プランを一意に識別するコードになります。Simulation APIのみをご契約の場合は、診断対象としたいfee_plan_codeをお伝えいたします。Plan APIから取得することもできます。
    • リクエストのJSONの例をsample_requests/req-sample-gas-tepco.jsonに示します。この例ではfee_plan_codeに東京電力エナジーパートナー従量電灯B(ozkxj|hzozmtmvoztgdbcodibtw-ozkxj)を比較元プランとし、比較対象プランとして東京電力エナジーパートナー従量電灯B、サンプルガス従量電灯B(nvhkgzvbvn|hzozmtmvoztgdbcodibtw-ozkxj)、サンプルガス従量電灯B(ガス割)(nvhkgzvbvn|hzozmtmvoztgdbcodibtwtb-ozkxj)としています。
# curlの場合
curl -X POST -H "Content-Type: application/json" -H "X-EMAP-USER-KEY:emapapidemouser1234" -d @req-sample-gas-tepco.json https://emap-sim-base.enechange.jp/v001/elec/simulate > emap_simulation.json
curl -X POST -H "Content-Type: application/json" -H "X-EMAP-USER-KEY:emapapidemouser1234" -d '{"request_id":"E00001","postcode":"1000004","fee_plan_code":"ozkxj|hzozmtmvoztgdbcodibtw-ozkxj","contract_ampere":40,"unit_type":1,"base_YYYYmm":"202010","fee_history":["8000","","","","","","","","","","",""],"usage_history":["","","","","","","","","","","",""],"weekday_night_usage_percentage":25,"all_electric":false,"fee_plan_codes":["ozkxj|hzozmtmvoztgdbcodibtw-ozkxj","nvhkgzvbvn|hzozmtmvoztgdbcodibtw-ozkxj","nvhkgzvbvn|hzozmtmvoztgdbcodibtwtb-ozkxj"]}' https://emap-sim-base.enechange.jp/v001/elec/simulate > emap_simulation.json

# wgetの場合
wget -q -O emap_simulation.json https://emap-sim-base.enechange.jp/v001/elec/simulate --post-file req-sample-gas-tepco.json --header='X-EMAP-USER-KEY:emapapidemouser1234' --header 'Content-Type: application/json' --header 'Accept: application/json'

cat emap_simulation.json | jq

デモ環境について

  • EMAP APIではデモ環境を用意しております。デモ環境はEMAP APIのご利用を検討されている方はどなたでもご利用できます。

ご利用時間

9:00〜21:00

  • 予告なくメンテナンス等でご利用できない場合がございます

利用できる郵便番号

  • APIには郵便番号で絞り込みできるものがありますが、デモ環境では利用できる郵便番号に制限があります。
  • 利用できる郵便番号は以下になります。
エリア名 郵便番号 住所
北海道電力エリア 0010013 北海道札幌市北区北十三条西
東北電力エリア 9800004 宮城県仙台市青葉区宮町
東京電力エリア 1000004 東京都千代田区大手町
中部電力エリア 4530838 愛知県名古屋市中村区向島町
北陸電力エリア 9300014 富山県富山市館出町
関西電力エリア 5300001 大阪府大阪市北区梅田
中国電力エリア 7300001 広島県広島市中区白島北町
四国電力エリア 7600001 香川県高松市新北町
九州電力エリア 8120006 福岡県福岡市博多区上牟田
沖縄電力エリア 9000004 沖縄県那覇市

取得可能プラン

  • 以下にデモ環境で取得できるプランを列挙します。
  • デモ環境で取得できる単価は最新の値に追従していない場合があります。
  • サンプルガスはデモ用に用意した事業者になります。取得できる単価は仮想の値となります。
エリア名 事業者名 プラン名 fee_plan_code(※)
北海道電力エリア 北海道電力 従量電灯B czkxj|hzozmtmvoztgdbcodibtw-czkxj
従量電灯C czkxj|hzozmtmvoztgdbcodibtx-czkxj
eタイム3プラス czkxj|zodhztbtkgpn-czkxj
低圧電力 czkxj|gjrtqjgovbz-czkxj
サンプルガス 従量電灯B nvhkgzvbvn|hzozmtmvoztgdbcodibtw-czkxj
従量電灯B(ガス割) nvhkgzvbvn|hzozmtmvoztgdbcodibtwtb-czkxj
従量電灯C nvhkgzvbvn|hzozmtmvoztgdbcodibtx-czkxj
従量電灯C(ガス割) nvhkgzvbvn|hzozmtmvoztgdbcodibtxtb-czkxj
低圧電力 nvhkgzvbvn|gjrtqjgovbz-czkxj
東北電力エリア 東北電力 従量電灯B ojcjfpvzkxj|hzozmtmvoztgdbcodibtw-ojcjfpvzkxj
従量電灯C ojcjfpvzkxj|hzozmtmvoztgdbcodibtx-ojcjfpvzkxj
よりそう+ナイト8(kVA契約) ojcjfpvzkxj|tjmdnjptidbcotg-ojcjfpvzkxj
よりそう+ナイト8(実量契約) ojcjfpvzkxj|tjmdnjptidbcotgtedonpmtjp-ojcjfpvzkxj
低圧電力 ojcjfpvzkxj|gjrtqjgovbz-ojcjfpvzkxj
サンプルガス 従量電灯B nvhkgzvbvn|hzozmtmvoztgdbcodibtw-ojcjfpvzkxj
従量電灯C nvhkgzvbvn|hzozmtmvoztgdbcodibtx-ojcjfpvzkxj
お家ぷらん nvhkgzvbvn|cjhztkgvi-ojcjfpvzkxj
低圧電力 nvhkgzvbvn|gjrtqjgovbz-ojcjfpvzkxj
東京電力エリア 東京電力エナジーパートナー 従量電灯B ozkxj|hzozmtmvoztgdbcodibtw-ozkxj
従量電灯C ozkxj|hzozmtmvoztgdbcodibtx-ozkxj
スマートライフS ozkxj|nhvmotgdaztn-ozkxj
低圧電力 ozkxj|gjrtqjgovbz-ozkxj
サンプルガス 従量電灯B nvhkgzvbvn|hzozmtmvoztgdbcodibtw-ozkxj
従量電灯B(ガス割) nvhkgzvbvn|hzozmtmvoztgdbcodibtwtb-ozkxj
従量電灯C nvhkgzvbvn|hzozmtmvoztgdbcodibtx-ozkxj
従量電灯C(ガス割) nvhkgzvbvn|hzozmtmvoztgdbcodibtxtb-ozkxj
低圧電力 nvhkgzvbvn|gjrtqjgovbz-ozkxj
中部電力エリア 中部電力ミライズ 従量電灯B xcpyzi|hzozmtmvoztgdbcodibtw-xcpyzi
従量電灯C xcpyzi|hzozmtmvoztgdbcodibtx-xcpyzi
スマートライフプラン xcpyzi|nhvmotgdaz-xcpyzi
低圧電力 xcpyzi|gjrtqjgovbz-xcpyzi
サンプルガス 従量電灯B nvhkgzvbvn|hzozmtmvoztgdbcodibtw-xcpyzi
従量電灯C nvhkgzvbvn|hzozmtmvoztgdbcodibtx-xcpyzi
低圧電力 nvhkgzvbvn|gjrtqjgovbz-xcpyzi
北陸電力エリア 北陸電力 従量電灯B mdfpyzi|hzozmtmvoztgdbcodibtw-mdfpyzi
従量電灯C mdfpyzi|hzozmtmvoztgdbcodibtx-mdfpyzi
くつろぎナイト12 mdfpyzi|fponpmjbdtza-mdfpyzi
低圧電力 mdfpyzi|gjrtqjgovbz-mdfpyzi
関西電力エリア 関西電力 従量電灯A fzkxj|hzozmtmvoztgdbcodibtv-fzkxj
従量電灯B fzkxj|hzozmtmvoztgdbcodibtw-fzkxj
はぴeタイムR fzkxj|cvkdtztodhztmtedonpmtjp-fzkxj
低圧電力 fzkxj|gjrtqjgovbz-fzkxj
サンプルガス 従量電灯A nvhkgzvbvn|hzozmtmvoztgdbcodibtv-fzkxj
従量電灯A(ガス割) nvhkgzvbvn|hzozmtmvoztgdbcodibtvtb-fzkxj
従量電灯B nvhkgzvbvn|hzozmtmvoztgdbcodibtwtf-fzkxj
従量電灯B(ガス割) nvhkgzvbvn|hzozmtmvoztgdbcodibtwtftb-fzkxj
低圧電力 nvhkgzvbvn|gjrtqjgovbz-fzkxj
中国電力エリア 中国電力 従量電灯A zizmbdv|hzozmtmvoztgdbcodibtv-zizmbdv
従量電灯B zizmbdv|hzozmtmvoztgdbcodibtw-zizmbdv
ぐっとずっと。プラン 電化Styleコース zizmbdv|yzifv-zizmbdv
低圧電力 zizmbdv|gjrtqjgovbz-zizmbdv
サンプルガス 従量電灯A nvhkgzvbvn|hzozmtmvoztgdbcodibtv-zizmbdv
従量電灯B nvhkgzvbvn|hzozmtmvoztgdbcodibtwtf-zizmbdv
低圧電力 nvhkgzvbvn|gjrtqjgovbz-zizmbdv
四国電力エリア 四国電力 従量電灯A tjiyzi|hzozmtmvoztgdbcodibtv-tjiyzi
従量電灯B tjiyzi|hzozmtmvoztgdbcodibtw-tjiyzi
でんかeプラン tjiyzi|yzifvtz-tjiyzi
低圧電力 tjiyzi|gjrtqjgovbz-tjiyzi
サンプルガス 従量電灯A nvhkgzvbvn|hzozmtmvoztgdbcodibtv-tjiyzi
従量電灯B nvhkgzvbvn|hzozmtmvoztgdbcodibtwtf-tjiyzi
低圧電力 nvhkgzvbvn|gjrtqjgovbz-tjiyzi
九州電力エリア 九州電力 従量電灯B ftpyzi|hzozmtmvoztgdbcodibtw-ftpyzi
従量電灯C ftpyzi|hzozmtmvoztgdbcodibtx-ftpyzi
電化でナイト・セレクト22 ftpyzi|yzifvtyztidbcotnzgzxo-ftpyzi
低圧電力 ftpyzi|gjrtqjgovbz-ftpyzi
サンプルガス 従量電灯B nvhkgzvbvn|hzozmtmvoztgdbcodibtw-ftpyzi
従量電灯C nvhkgzvbvn|hzozmtmvoztgdbcodibtx-ftpyzi
低圧電力 nvhkgzvbvn|gjrtqjgovbz-ftpyzi
沖縄電力エリア 沖縄電力 従量電灯 jfdyzi|hzozmtmvoztgdbcodib-jfdyzi
Ee ホームホリデー jfdyzi|zzcjhztcjgdyvt-jfdyzi
低圧電力 jfdyzi|gjrtqjgovbz-jfdyzi

※Simulation API 利用時に必要な値となります。Plan APIでは必要ありません。

#:## 取得期間(燃料費調整額、再生可能エネルギー賦課金)

  • デモ環境では、燃料費調整額と再生可能エネルギー発電促進賦課金に関しては、現在の年を含んで過去3年分のみレスポンスを返します。

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •