申し訳ありません。お使いのブラウザーはJavaScriptをサポートしていません。
サインイン

API で IAMMETER-Cloud をより効率的に活用する方法

前提

IAMMETER-Cloud はいくつかの API を提供しており、開発者はこれらの API を使用して、IAMMETER のデータをサードパーティのシステムに統合するなど、さまざまな活用ができます。 これまでこれらの API はビジネスパートナーと一部の大口顧客にのみ公開していましたが、現在はすべてのお客様に公開することにしました。

ご意見がありましたら、ぜひフォーラムでお知らせください。 https://imeter.club

API の制限

API は無制限に呼び出せるわけではありません。各 API の1日の呼び出し回数に制限を設けています。 API を必要以上に頻繁に呼び出さないでください。

呼び出し回数が時間単位または日単位の制限を超えた場合、API は何も返しません。

No. API 制限タイプ 時間当たり 日当たり 説明
1 /user/login ip 5 30 1つのIPアドレスにつき、このAPIを1時間に5回まで呼び出せます
2 /site/meterdata/ SN 12 1つのSNにつき、このAPIを1時間に12回まで呼び出せます
3 /site/powerAnalysis SN 5 1つのSNにつき、このAPIを1日に5回まで呼び出せます
4 /site/offlineAnalysis SN 5 1つのSNにつき、このAPIを1日に5回まで呼び出せます

アカウント:アカウントのトークンを取得する

アカウントのトークンを返します。 このトークンはほぼすべての API で使用されます。

トークンを更新したい場合を除き、この API を呼び出す必要はありません。 この API を1時間に5回以上、1日に30回以上呼び出さないでください。

URL とメソッド

すべての API で使用されるアカウントのトークンを取得します。

URL: https://www.iammeter.com/api/v1/user/login

メソッド: post

この API は IAMMETER SwaggerUI でトークンを取得 からオンラインでテストできます。

データ

No. パラメータ 備考
1 user name IAMMETER のユーザー名 test
2 password IAMMETER のパスワード 123456

レスポンス

トークンの値は以下のすべての API で使用されます。

{
    "data": {
        "id": 2025,
        "token": "349dfxxxxxxac5169",
        "refreshToken": "8adf75e5da10424985f3b83855133982"
    },
    "successful": true,
    "message": null
}

Web システムから直接トークンを取得する

このトークンは、システムにログインした後で直接読み取ることもできます。

image-20230921163110697

エネルギーメーター:最新のアップロードデータと UTC 時刻を取得する

指定した SN の最後にアップロードされたデータを取得します。

この API を1時間に12回以上呼び出さないでください。

URL とメソッド

Basic(meterdata): https://www.iammeter.com/api/v1/site/meterdata/{sn}

この API は IAMMETER SwaggerUI からオンラインでテストできます。

Advanced(meterdata2): https://www.iammeter.com/api/v1/site/meterdata2/{sn}

この API は IAMMETER SwaggerUI meterdataIAMMETER SwaggerUI meterdata2 からオンラインでテストできます。

メソッド: GET

制限: この API を1日288回(5分間隔)以上リクエストしないでください。

Basic と Advanced の違い:

Basic: PF(力率)なし

Advanced: PF(力率)あり

パラメータ

名前
Token String xxx required
rtctime string 2025-6-16 optional

レスポンス:単相 - meterdata(力率なし)

値の定義: voltage, current, active power, imported kWh, exported kWh

{
    "data": {
        "values": [
            [
                230.220, //voltage
                1.300, //curent
                119.000,//active power
                1766.590, //imported kWh
                0.000 //exported kWh
            ]
        ],
        "localTime": "2020/8/28 15:27:33",
        "gmtTime": "2020/8/28 5:27:33"
    },
    "successful": true,
    "message": null
}

レスポンス:単相 - meterdata2(力率あり)

値の定義: voltage, current, active power, power factor, imported kWh, exported kWh.

力率が有効電力と買電電力量の間に配置されているのは最適とは言えないことは認識していますが、現在のフォーマットはこのように設定されているため、この配置にご注意ください。

{
    "data":{
        "values":[
            [
                233.41, //voltage
                0.718,//current
                111,//active power
                0.66,//power factor
                5724.85, //imported energy
                0 //exported energy 
            ]
        ],
        "localTime":"2023/11/21 14:30:22",
        "gmtTime":"2023/11/21 6:30:22"
    },
    "successful":true,
    "message":null
}

レスポンス:三相 - meterdata(力率なし)

values の3つの配列は、A相、B相、C相を表します。

値の定義: voltage, current, active power, imported kWh, exported kWh

{
    "data": {
        "values": [
            [
                242.600,//voltage
                1.000,//current
                216.000,//active power
                32354.600,//imported energy
                0.000//exported energy 
            ],
            [
                242.600,
                1.000,
                1986.000,
                30536.410,
                17704.720
            ],
            [
                0.000,
                0.000,
                0.000,
                0.000,
                0.000
            ]
        ],
        "localTime": "2020/8/28 15:30:48",
        "gmtTime": "2020/8/28 5:30:48"
    },
    "successful": true,
    "message": null
}

レスポンス:三相 - meterdata2(力率あり)

要素の定義: voltage, current, active power, power factor, imported kWh, exported kWh

{
    "data":{
        "values":[
            [//phase A
                233.8,//voltage
                0.03,//current
                4,//active power
                0.57,//power factor
                222.53,//imported kWh
                0 //exported kWh
            ],
            [//phase B
                5,
                0,
                0,
                0,
                0,
                0
            ],
            [ //phase C
                3.1,
                0,
                0,
                0,
                0,
                0
            ]
        ],
        "localTime":"2023/11/21 14:39:36",
        "gmtTime":"2023/11/21 6:39:36"
    },
    "successful":true,
    "message":null
}

例(最新のアップロード値を取得)

image-20230921164457116

例(指定した RTC 時刻に近い値を取得)

RTC(リアルタイムクロック)も、以下のように HTTP GET リクエストのパラメータに含まれます。

https://www.iammeter.com/api/v1/site/meterdata/59C9AB8D?token=336c9cbebcbf49139f0be060cc7ba7fd&rtctime=2025-6-16

このリクエストは、指定した日付(2025-6-16)に最も近いアップロード済みのメーターデータ値、つまり最も近い記録時刻の値を返します。

エネルギーメーター:履歴レコードを取得する

注意:これらの API は前の章と同じで、パラメータがいくつか追加されているだけです

設定した間隔と時間範囲の履歴データを返します。

  • 時間範囲:直近1か月
  • 最大データ長:2000件

瞬時データは1分間隔です。1日あたり 60*24=1440 件のデータがあります。 1分間隔で履歴データをリクエストする場合、1.39日分(2000/1440)のデータしかリクエストできません。 ただし、5分間隔でリクエストする場合は、約7日分のデータをリクエストできます。

URL とメソッド

Basic(meterdatalist): https://www.iammeter.com/api/v1/site/meterdatalist/{sn}

Advanced(meterdatalist2): https://www.iammeter.com/api/v1/site/meterdatalist2/{sn}

Basic と Advanced の違い:

Basic: PF(力率)なし

Advanced: PF(力率)あり

この API は IAMMETER SwaggerUI meterdataIAMMETER SwaggerUI meterdata2 からオンラインでテストできます。

パラメータ

名前
Token String xxx required
interval number 300 required, unit: second
startTime string 2023-09-01 required
endTime string 2023-09-07 required

レスポンス:単相 - meterdatalist

データ: [voltage, current, power, import energy, export energy, utc time, local time]



{
    "data": [
        [
            227.73,
            1.45,
            172,
            13121.56,
            0,
            "2023/9/12 0:00:34",
            "2023/9/11 14:00:34"
        ],
        [
            229.43,
            1.45,
            172,
            13121.56,
            0,
            "2023/9/12 0:01:33",
            "2023/9/11 14:01:33"
        ]
    ],
    "successful": true,
    "message": null
}

レスポンス:三相 - meterdatalist

{
    "data": [
        [
            230,//phaseA voltage
            0,//current
            0,//active power
            468.41,//imported kWh
            0,//exported kWh
            230,//PhaseB  
            0, 
            0,
            236.58,
            290.77,
            230,//Phase C
            0,
            0,
            258.62,
            0,
            "2023/9/12 0:00:15",
            "2023/9/11 16:00:15"
        ],
        [
            230,
            0,
            0,
            468.41,
            0,
            230,
            0,
            0,
            236.58,
            290.77,
            230,
            0,
            0,
            258.62,
            0,
            "2023/9/12 0:02:08",
            "2023/9/11 16:02:08"
        ]
    ],
    "successful": true,
    "message": null
}

レスポンス:三相 - meterdatalist2

{
    "data":[
        { //first data
            "rtcTime":"2023/9/1 0:00:22",
            "gmtTime":"2023/8/31 16:00:22",
            "values":[
                [ //phase A
                    235.2,//voltage
                    0.03,//current
                    4,//active power 
                    0.57,//power factor
                    210.21,//import kWh
                    0 //exported kWh
                ],
                [//phase B
                    5.5,
                    0,
                    0,
                    0,
                    0,
                    0
                ],
                [ //phase C
                    3.3,
                    0,
                    0,
                    0,
                    0,
                    0
                ]
            ]
        },
        { //second data
            "rtcTime":"2023/9/1 8:00:49",
            "gmtTime":"2023/9/1 0:00:49",
            "values":[
                [
                    233.4,
                    0.03,
                    4,
                    0.57,
                    210.24,
                    0
                ],
                [
                    5.4,
                    0,
                    0,
                    0,
                    0,
                    0
                ],
                [
                    3.3,
                    0,
                    0,
                    0,
                    0,
                    0
                ]
            ]
        },
        { //third data
            "rtcTime":"2023/9/1 16:00:24",
            "gmtTime":"2023/9/1 8:00:24",
            "values":[
                [
                    235.6,
                    0.03,
                    4,
                    0.57,
                    210.27,
                    0
                ],
                [
                    5.5,
                    0,
                    0,
                    0,
                    0,
                    0
                ],
                [
                    3.4,
                    0,
                    0,
                    0,
                    0,
                    0
                ]
            ]
        }
    ],
    "successful":true,
    "message":null
}

https://www.iammeter.com/api/v1/Site/MeterDataList/{yourSN}?token={yourToken}&startTime=2023-09-01&endTime=2023-09-07&interval=300

image-20230926150649591

エネルギーメーター:電力読み値の分析

指定した時間の電力分析結果を返します。

この API を1日に5回以上呼び出さないでください。

URL とメソッド

URL: https://www.iammeter.com/api/v1/site/powerAnalysis

メソッド: get

制限: この API を SN ごとに1日5回以上リクエストしないでください。

パラメータ

名前
sn String xxx required
startTime String 2023-09-01 optional
endTime String 2023-09-07 optional

注意:

  1. 最大時間範囲は直近1か月の7日間です。
  2. 時間パラメータは任意です。指定しない場合、API は直近7日間の結果を返します。

レスポンス

average: この時間範囲の平均電力読み値。

averageDaytime: この時間範囲の昼間(8:00〜20:00)の平均電力読み値。

minimum: この時間範囲の最小電力読み値。

maximum: この時間範囲の最大電力読み値。

{
    "data": {
        "startTime": "2023-09-01",
        "endTime": "2023-09-07",
        "average": 862.6,
        "averageDaytime": 836.9,
        "minimum": 259.0,
        "maximum": 3999.0
    },
    "successful": true,
    "message": null
}

直近7日間の電力分析結果を返します。

image-20230921163444898

指定した日の電力分析結果を返します

https://www.iammeter.com/api/v1/site/powerAnalysis?token={YourToken}&sn={YourSN}&starttime=2023-09-21&endtime=2023-09-21

image-20230922101047074

エネルギーメーター:オフライン状態の分析

指定した時間内の指定 SN の切断状態を返します。

この API を1日に5回以上呼び出さないでください。

URL とメソッド

URLhttps://www.iammeter.com/api/v1/site/offlineAnalysis

メソッドGet

制限: この API を SN ごとに1日5回以上リクエストしないでください。

パラメータ

名前
sn String xxxx required
startTime String 2023-09-01 optional
endTime String 2023-09-07 optional
interval(単位:分) Number 5 optional

注意:

  1. 最大時間範囲は直近1か月の7日間です。
  2. 時間パラメータは任意です。指定しない場合、API は直近7日間の結果を返します。
  3. interval を指定しない場合、デフォルトは5分です。

レスポンス

この時間範囲には合計10080分あります。

この時間範囲の合計オフライン時間は906分です。

5分を超えるオフライン間隔は配列にリストされます。

{
    "data": {
        "startTime": "2023-09-05",
        "endTime": "2023-09-11",
        "offlineCount": 906,
        "totalCount": 10080,
        "list": [
            {
                "startTime": "2023/9/5 0:00:00",
                "endTime": "2023/9/5 15:06:14",
                "duration": 906   
            }
        ]
    },
    "successful": true,
    "message": null
}

指定した日のオフライン分析結果を返します

https://www.iammeter.com/api/v1/site/offlineAnalysis?token={YourToken}&sn={YourSN}&starttime=2023-09-21&endtime=2023-09-21

image-20230922101653639

アカウント:単一アカウント内のすべてのエネルギーメーターから最新データを取得する

このアカウント内のすべてのエネルギーメーターの最新値を返します。

URL とメソッド

URLhttps://www.iammeter.com/api/v1/site/metersdata?token=xxx

メソッドGet

制限: この API へのリクエストは5分に1回以下の頻度にしてください。

パラメータ

名前
Token String xxx required

レスポンス

{
    "data":[
        {
            "sn":"DA2BED94",
            "values":[
                223.71,
                1.74,
                225,
                14761.03,
                0
            ],
            "gmtTime":"2024/2/22 3:46:20"
        },
        {
            "sn":"B384789C",
            "values":[
                [
                    248.9,
                    13.9,
                    3356,
                    21228,
                    0,
                    null,
                    null
                ],
                [
                    248.9,
                    13.9,
                    -2747,
                    8988.48,
                    18489.44,
                    null,
                    null
                ],
                [
                    null,
                    null,
                    null,
                    null,
                    null,
                    null,
                    null
                ],
                [
                    248.9,
                    13.9,
                    -2747,
                    8988.48,
                    18489.44,
                    null,
                    null
                ]
            ],
            "gmtTime":"2024/2/22 3:45:15"
        },
        {
            "sn":"674B1E5D",
            "values":[
                [
                    220.4,
                    1.86,
                    377,
                    5345.985,
                    20.565
                ],
                [
                    220.4,
                    1.86,
                    377,
                    5367.715,
                    0.033
                ],
                [
                    220.5,
                    1.86,
                    377,
                    5369.532,
                    0.033
                ]
            ],
            "gmtTime":"2024/2/22 3:45:50"
        },
        {
            "sn":"59C9AB8D",
            "values":[
                [
                    245.3,
                    6.5,
                    1604,
                    46055.7,
                    0,
                    null,
                    null
                ],
                [
                    245.3,
                    6.5,
                    -910,
                    15726.73,
                    8956.56,
                    null,
                    null
                ],
                [
                    null,
                    null,
                    null,
                    null,
                    null,
                    null,
                    null
                ],
                [
                    245.3,
                    6.5,
                    -910,
                    15726.73,
                    8956.56,
                    null,
                    null
                ]
            ],
            "gmtTime":"2024/2/22 3:45:15"
        },
        {
            "sn":"3FE34ABE",
            "values":[
                [
                    230,
                    15.9,
                    3650.1,
                    2704.35,
                    0,
                    49.99,
                    0.94
                ],
                [
                    230,
                    -11.5,
                    -2650.1,
                    1411.31,
                    1722.35,
                    49.99,
                    0.94
                ],
                [
                    230,
                    4.3,
                    1000,
                    1946.03,
                    0,
                    49.99,
                    0.94
                ]
            ],
            "gmtTime":"2024/2/22 3:46:01"
        }
    ],
    "successful":true,
    "message":null
}

image-20240222114848312

プレイス:使用タイプごとの時間別・日別 kWh データを返す

インバーターの発電量と系統との電力交換(売電と買電の両方)の時間別・日別 kWh 値を取得します。

URL とメソッド

URL:https://www.iammeter.com/api/v1/site/energyhistory/?startTime={2024-05-05}&endTime={2024-07-07}&groupby=&Token={2be6d1xxxxxxcc688}

メソッド: get

制限

groupby = day :90日分のデータ(90件)

groupby = hour :7日分のデータ(168件)

パラメータ

名前 説明
Token String アカウントのトークン xxx required
place_ID number プレイスの ID required
startTime string この API が返す開始時間 2023-09-01 required
endTime string この API が返す終了時間 2023-09-07 required
groupby enum 返すデータの間隔(hour/day)を選択 day/hour required

Place_ID: My Places→編集

place_id

レスポンス:単相

place_id:1360

startTime=2024-05-05

endTime=2024-05-07

groupby=day

https://www.iammeter.com/api/v1/site/energyhistory/1360?startTime=2024-05-05&endTime=2024-05-07&groupby=day&Token=f7eba1ac8c194b3fbc8e79b8af0adb72

{
	"data": [{
			"time": "2024/5/5 0:00:00",
			"yield": 0,
			"fromGrid": 9.62,
			"toGrid": 0,
			"specialLoad": 0,
			"selfUse": 0
		},
		{
			"time": "2024/5/6 0:00:00",
			"yield": 0,
			"fromGrid": 9.16,
			"toGrid": 0,
			"specialLoad": 0,
			"selfUse": 0
		}
	],
	"successful": true,
	"message": null
}

レスポンス:三相

place_id:2393

startTime=2024-05-05

endTime=2024-05-07

groupby=day

https://www.iammeter.com/api/v1/site/energyhistory/2393?startTime=2024-05-05&endTime=2024-05-07&groupby=day&Token=f7eba1ac8c194b3fbc8e79b8af0adb72

{
	"data": [{
			"time": "2024/5/5 0:00:00",
			"yield": 0,
			"fromGrid": 0,
			"toGrid": 0,
			"specialLoad": 0,
			"selfUse": 0
		},
		{
			"time": "2024/5/6 0:00:00",
			"yield": 0.1,
			"fromGrid": 0.22,
			"toGrid": 7.15,
			"specialLoad": 0,
			"selfUse": 0
		}
	],
	"successful": true,
	"message": null
}

place_id:2393

startTime=2024-05-05

endTime=2024-05-06

groupby=hour

https://www.iammeter.com/api/v1/site/energyhistory/2393?startTime=2024-05-05&endTime=2024-05-07&groupby=day&Token=f7eba1ac8c194b3fbc8e79b8af0adb72

{
	"data": [{
			"time": "2024/5/5 0:00:00",
			"yield": 0,
			"fromGrid": 0,
			"toGrid": 0,
			"specialLoad": 0,
			"selfUse": 0
		},
		{
			"time": "2024/5/5 1:00:00",
			"yield": 0,
			"fromGrid": 0,
			"toGrid": 0,
			"specialLoad": 0,
			"selfUse": 0
		},
		{
			"time": "2024/5/5 2:00:00",
			"yield": 0,
			"fromGrid": 0,
			"toGrid": 0,
			"specialLoad": 0,
			"selfUse": 0
		},
		{
			"time": "2024/5/5 3:00:00",
			"yield": 0,
			"fromGrid": 0,
			"toGrid": 0,
			"specialLoad": 0,
			"selfUse": 0
		},
		{
			"time": "2024/5/5 4:00:00",
			"yield": 0,
			"fromGrid": 0,
			"toGrid": 0,
			"specialLoad": 0,
			"selfUse": 0
		},
		{
			"time": "2024/5/5 5:00:00",
			"yield": 0,
			"fromGrid": 0,
			"toGrid": 0,
			"specialLoad": 0,
			"selfUse": 0
		},
		{
			"time": "2024/5/5 6:00:00",
			"yield": 0,
			"fromGrid": 0,
			"toGrid": 0,
			"specialLoad": 0,
			"selfUse": 0
		},
		{
			"time": "2024/5/5 7:00:00",
			"yield": 0,
			"fromGrid": 0,
			"toGrid": 0,
			"specialLoad": 0,
			"selfUse": 0
		},
		{
			"time": "2024/5/5 8:00:00",
			"yield": 0,
			"fromGrid": 0,
			"toGrid": 0,
			"specialLoad": 0,
			"selfUse": 0
		},
		{
			"time": "2024/5/5 9:00:00",
			"yield": 0,
			"fromGrid": 0,
			"toGrid": 0,
			"specialLoad": 0,
			"selfUse": 0
		},
		{
			"time": "2024/5/5 10:00:00",
			"yield": 0,
			"fromGrid": 0,
			"toGrid": 0,
			"specialLoad": 0,
			"selfUse": 0
		},
		{
			"time": "2024/5/5 11:00:00",
			"yield": 0,
			"fromGrid": 0,
			"toGrid": 0,
			"specialLoad": 0,
			"selfUse": 0
		},
		{
			"time": "2024/5/5 12:00:00",
			"yield": 0,
			"fromGrid": 0,
			"toGrid": 0,
			"specialLoad": 0,
			"selfUse": 0
		},
		{
			"time": "2024/5/5 13:00:00",
			"yield": 0,
			"fromGrid": 0,
			"toGrid": 0,
			"specialLoad": 0,
			"selfUse": 0
		},
		{
			"time": "2024/5/5 14:00:00",
			"yield": 0,
			"fromGrid": 0,
			"toGrid": 0,
			"specialLoad": 0,
			"selfUse": 0
		},
		{
			"time": "2024/5/5 15:00:00",
			"yield": 0,
			"fromGrid": 0,
			"toGrid": 0,
			"specialLoad": 0,
			"selfUse": 0
		},
		{
			"time": "2024/5/5 16:00:00",
			"yield": 0,
			"fromGrid": 0,
			"toGrid": 0,
			"specialLoad": 0,
			"selfUse": 0
		},
		{
			"time": "2024/5/5 17:00:00",
			"yield": 0,
			"fromGrid": 0,
			"toGrid": 0,
			"specialLoad": 0,
			"selfUse": 0
		},
		{
			"time": "2024/5/5 18:00:00",
			"yield": 0,
			"fromGrid": 0,
			"toGrid": 0,
			"specialLoad": 0,
			"selfUse": 0
		},
		{
			"time": "2024/5/5 19:00:00",
			"yield": 0,
			"fromGrid": 0,
			"toGrid": 0,
			"specialLoad": 0,
			"selfUse": 0
		},
		{
			"time": "2024/5/5 20:00:00",
			"yield": 0,
			"fromGrid": 0,
			"toGrid": 0,
			"specialLoad": 0,
			"selfUse": 0
		},
		{
			"time": "2024/5/5 21:00:00",
			"yield": 0,
			"fromGrid": 0,
			"toGrid": 0,
			"specialLoad": 0,
			"selfUse": 0
		},
		{
			"time": "2024/5/5 22:00:00",
			"yield": 0,
			"fromGrid": 0,
			"toGrid": 0,
			"specialLoad": 0,
			"selfUse": 0
		},
		{
			"time": "2024/5/5 23:00:00",
			"yield": 0,
			"fromGrid": 0,
			"toGrid": 0,
			"specialLoad": 0,
			"selfUse": 0
		}
	],
	"successful": true,
	"message": null
}

参考

WiFi エネルギーメーターの API

IAMMETER が提供できる機能とは?

どのタイプの電力量計があなたのニーズに最適ですか?

要件に応じた電力メーターの見つけ方

三相エネルギーメーターを好みの方法でお使いください

三相 WiFi エネルギーメーター

トップ