抱歉,你的浏览器不支持 JavaScript!
登录

如何通过 API 更高效地使用 IAMMETER-cloud

前提

IAMMETER-cloud 提供了一些 API,开发者可以使用这些 API 完成一些有趣的工作,例如将 IAMMETER 的数据集成到第三方系统中。 此前我们仅向商业合作伙伴和一些大客户开放了这些 API,现在我们决定向所有客户开放。

欢迎在我们的论坛上分享您的想法。 https://imeter.club

API 限制

API 无法无限次访问,我们将限制每个 API 的每日调用次数。 请不要过于频繁地调用 API。

如果调用次数超过了每小时或每日的限制,API 将不返回任何内容。

No. API 限制类型 每小时 每日 说明
1 /user/login ip 5 30 每个 IP 每小时最多调用此 API 5 次
2 /site/meterdata/ SN 12 每个 SN 每小时最多调用此 API 12 次
3 /site/powerAnalysis SN 5 每个 SN 每天最多调用此 API 5 次
4 /site/offlineAnalysis SN 5 每个 SN 每天最多调用此 API 5 次

账户:获取账户的 Token

返回账户的 token。 该 token 将用于几乎所有 API。

除非您想刷新 token,否则无需调用此 API。 请不要在一小时内调用此 API 超过 5 次,一天内不超过 30 次。

URL 与方法

获取用于所有 API 的账户 token。

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

方法**:post**

此 API 可在线测试,请访问 IAMMETER SwaggerUI 获取 token

数据

No. 参数 说明 示例
1 user name IAMMETER 的用户名 test
2 password IAMMETER 的密码 123456

响应

该 token 值将用于以下所有 API。

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

直接从 Web 系统获取 Token

登录系统后,您也可以直接读取此 token。

image-20230921163110697

电能表:获取最新上传数据和 UTC 时间

获取指定 SN 的最后一次上传数据。

请不要在一小时内调用此 API 超过 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 不要超过 288 次(5 分钟间隔)。

Basic 和 Advanced 的区别

Basic:不含 PF(功率因数)

Advanced:含 PF(功率因数)

参数

名称 类型 示例
Token String xxx 必填
rtctime string 2025-6-16 可选

响应:单相 - meterdata(不含功率因数)

数值定义:电压、电流、有功功率、导入 kWh、导出 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(含功率因数)

数值定义:电压、电流、有功功率、功率因数、导入 kWh、导出 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 中的三个数组分别代表 A 相、B 相和 C 相。

数值定义:电压、电流、有功功率、导入 kWh、导出 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(含功率因数)

元素定义:电压、电流、有功功率、功率因数、导入 kWh、导出 kWh

{
    "data":{
        "values":[
            [//A 相
                233.8,//voltage
                0.03,//current
                4,//active power
                0.57,//power factor
                222.53,//imported kWh
                0 //exported kWh
            ],
            [//B 相
                5,
                0,
                0,
                0,
                0,
                0
            ],
            [ //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 与上一章相同,仅增加了一些参数

返回设定时间间隔和时间范围内的历史数据。

  • 时间范围:最近一个月
  • 最大数据长度:2000 条

实时数据为 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 必填
interval number 300 必填,单位:秒
startTime string 2023-09-01 必填
endTime string 2023-09-07 必填

响应:单相 - meterdatalist

数据:[电压、电流、功率、导入电能、导出电能、UTC 时间、本地时间]



{
    "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,//A 相电压
            0,//current
            0,//active power
            468.41,//imported kWh
            0,//exported kWh
            230,//B 相  
            0, 
            0,
            236.58,
            290.77,
            230,//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":[
        { //第一条数据
            "rtcTime":"2023/9/1 0:00:22",
            "gmtTime":"2023/8/31 16:00:22",
            "values":[
                [ //A 相
                    235.2,//voltage
                    0.03,//current
                    4,//active power 
                    0.57,//power factor
                    210.21,//import kWh
                    0 //exported kWh
                ],
                [//B 相
                    5.5,
                    0,
                    0,
                    0,
                    0,
                    0
                ],
                [ //C 相
                    3.3,
                    0,
                    0,
                    0,
                    0,
                    0
                ]
            ]
        },
        { //第二条数据
            "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
                ]
            ]
        },
        { //第三条数据
            "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 超过 5 次。

URL 与方法

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

方法: get

限制: 每个 SN 每天请求此 API 不要超过 5 次。

参数

名称 类型 示例
sn String xxx 必填
startTime String 2023-09-01 可选
endTime String 2023-09-07 可选

注意:

  1. 最大时间范围为最近一个月内的 7 天。
  2. 时间参数可选,如果不使用该参数,API 将返回最近 7 天的结果。

响应

average:该时间范围内的平均功率读数。

averageDaytime:该时间范围内的日间(上午 8:00 至晚上 8: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 超过 5 次。

URL 与方法

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

方法Get

限制:每个 SN 每天请求此 API 不要超过 5 次。

参数

名称 类型 示例
sn String xxxx 必填
startTime String 2023-09-01 可选
endTime String 2023-09-07 可选
interval(单位:分钟) Number 5 可选

注意:

  1. 最大时间范围为最近一个月内的 7 天。
  2. 时间参数可选,如果不使用该参数,API 将返回最近 7 天的结果。
  3. 如果不指定间隔,默认为 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 分钟一次。

参数

名称 类型 示例
Token String xxx 必填

响应

{
    "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 账户的 token xxx 必填
place_ID number 场所的 ID 必填
startTime string API 返回数据的开始时间 2023-09-01 必填
endTime string API 返回数据的结束时间 2023-09-07 必填
groupby enum 选择返回数据间隔(小时/天) day/hour 必填

Place_ID: 我的场所->编辑

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 电能表

顶部