IAMMETER-cloud provides some APIs, and the developer can use these APIs to do some interesting work, such as integrating the data of IAMMETER to some third-party system. We just opened these APIs to our business partners and some big customers before, but decided to open them to all of our customers now.
Welcome to let us know your thought on our forum. https://imeter.club
The API can not be visited unlimited, we will limit the daily calling count for each API. Please do not call the API more frequently.
If the call counts exceeds the hourly or daily limitation, the API will return nothing.
| Ne. | API | limit type | hourly | Denně | description |
|---|---|---|---|---|---|
| 1 | /user/login | ip | 5 | 30 | one IP only be allowed to call this api 5 times hourly |
| 2 | /site/meterdata/ | SN | 12 | one SN only be allowed to call this api 12 times hourly | |
| 3 | /site/powerAnalysis | SN | 5 | one SN only be allowed to call this api 5 times daily | |
| 4 | /site/offlineAnalysis | SN | 5 | one SN only be allowed to call this api 5 times daily |
Return the token of the account. The token will be used in nearly all of the API.
You do not need to call this API unless you want to refresh the token. Please do not call this API more than 5 times in one hour, and not more than 30 times in one day.
Get the token of the account which is used in all of the APIs.
URL:https://www.iammeter.com/api/v1/user/login
Method: post
| Ne. | parameter | remark | example |
|---|---|---|---|
| 1 | user name | User name of IAMMETER | test |
| 2 | password | password of IAMMETER | 123456 |
The token value will be used in all of the APIs below.
{
"data": {
"id": 2025,
"token": "349dfxxxxxxac5169",
"refreshToken": "8adf75e5da10424985f3b83855133982"
},
"successful": true,
"message": null
}
This token can also be read directly after you log in to the system.
Get the last uploading data with the regarded SN.
Please do not call this API more than 12 times in one hour.
Basic(meterdata): https://www.iammeter.com/api/v1/site/meterdata/{sn}
Advanced(meterdata2): https://www.iammeter.com/api/v1/site/meterdata2/{sn}
Method: GET
Limit: please do not request this API more than 288 times each day(5 minutes interval).
The difference between basic and advanced:
Basic: without PF(Power factor)
Advanced: with PF(Power factor)
| Name | Type | Example | |
|---|---|---|---|
| Token | String | xxx | required |
values definition: voltage,current ,active power ,imported Kwh, exported Kwh
{
"data": {
"values": [
[
230.220,
1.300,
119.000,
1766.590,
0.000
]
],
"localTime": "2020/8/28 15:27:33",
"gmtTime": "2020/8/28 5:27:33"
},
"successful": true,
"message": null
}
values definition: voltage,current ,active power ,power factor,imported Kwh, exported Kwh
{
"data":{
"values":[
[
233.41,
0.718,
111,
0.66,
5724.85,
0
]
],
"localTime":"2023/11/21 14:30:22",
"gmtTime":"2023/11/21 6:30:22"
},
"successful":true,
"message":null
}
The three arrays in values represent Phase A, phase B, and Phase C.
Element definition: voltage,current ,active power ,power factor,imported Kwh, exported Kwh
{
"data": {
"values": [
[
242.600,
1.000,
216.000,
32354.600,
0.000
],
[
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
}
{
"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
}
Return the historical data on the set interval and time range.
The instant data is in 1 min interval. There are 60*24=1440 pieces of data per day. If you request the historical data in 1 min interval, you can only request the data of 1.39(2000/1440) days. But if you request the data in 5 mins interval ,you can request the data of nearly 7 days.
Basic(meterdatalist):https://www.iammeter.com/api/v1/site/meterdatalist/
**Advanced(meterdatalist2):**https://www.iammeter.com/api/v1/site/meterdatalist2/{sn}
The difference between basic and advanced:
Basic: without PF(Power factor)
Advanced: with PF(Power factor)
| Name | Type | Example | |
|---|---|---|---|
| Token | String | xxx | required |
| interval | number | 300 | required, unit: second |
| startTime | string | 2023-09-01 | required |
| endTime | string | 2023-09-07 | required |
Data:[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
}
{
"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
}
{
"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
}
Return the power analysis result in the specified time .
Please do not call this API more than 5 times in one day.
URL:https://www.iammeter.com/api/v1/site/powerAnalysis
Method: get
Limit: Please do not request this API per SN more than 5 times each day.
| Name | Type | Example | |
|---|---|---|---|
sn |
String | xxx | required |
startTime |
String | 2023-09-01 | optional |
endTime |
String | 2023-09-07 | optional |
Poznámka:
average: average power reading during this time range.
averageDaytime: average Daytime(8:00am-8:00pm) power reading during this time range.
minimum: minimum power reading during this time range.
maximum: maximum power reading during this time range.
{
"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
}
Return the power analysis result of the last 7 days.
Return the power analysis result of the specified day
Return the disconnection status with regarded SN in the specified time.
Please do not call this API more than 5 times in one day.
URL：https://www.iammeter.com/api/v1/site/offlineAnalysis
Method：Get
Limit: Please do not request this API per SN more than 5 times each day.
| Name | Type | Example | |
|---|---|---|---|
sn |
String | xxxx | required |
startTime |
String | 2023-09-01 | optional |
endTime |
String | 2023-09-07 | optional |
interval(unit :minute) |
Number | 5 | optional |
Poznámka:
There are total 10080 minutes in this time range.
The total offline time is 906 minutes in this time range.
The offline gap that is greater than 5 minutes is listed in the array.
{
"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
}
Return the offline analysis result of the specified day
