Readings
List all Readings for an Entity
API Reference
Core Resources
- Entities
- Collectives
- Tenants
Onboarding API
- Entity Onboarding
- Collective Onboarding
- Guided Onboarding
Readings API
- Readings
- Aggregations
Commands API
- Trigger or Schedule
- GETRetrieve a Command
- GETList all Commands
- PATCHCancel a Command
Charge Sessions API
Entity Settings
- Features
- Locations
- Battery Capacity
- Heated Area
- Disaggregators
- Custom Properties
Offboarding API
- Offboard Entities
Readings
List all Readings for an Entity
Returns a page of normalized Readings for a specific Entity, optionally with additional filters
GET
/
v1
/
entities
/
{entityId}
/
readings
curl --request GET \
--url https://platform.realto.io/api/v1/entities/{entityId}/readings \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"data": {
"instantaneousCurrent": {
"l1": 123,
"l2": 123,
"l3": 123,
"total": 123,
"unit": "<string>"
},
"instantaneousVoltage": {
"l1": 123,
"l2": 123,
"l3": 123,
"total": 123,
"unit": "<string>"
},
"isCharging": true,
"isPluggedIn": true,
"location": {
"address": "<string>",
"latitude": 123,
"longitude": 123
},
"locationMatches": [
{
"accuracy": 123,
"location": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>"
}
}
],
"negativeActiveEnergy": {
"t1": 123,
"t2": 123,
"t3": 123,
"t4": 123,
"total": 123,
"unit": "<string>"
},
"negativeActiveEnergyPhases": {
"l1": 123,
"l2": 123,
"l3": 123,
"total": 123,
"unit": "<string>"
},
"negativeActiveInstantaneousPower": {
"l1": 123,
"l2": 123,
"l3": 123,
"total": 123,
"unit": "<string>"
},
"negativeGasVolume": {
"unit": "<string>",
"value": 123
},
"odometer": {
"unit": "<string>",
"value": 123
},
"positiveActiveEnergy": {
"t1": 123,
"t2": 123,
"t3": 123,
"t4": 123,
"total": 123,
"unit": "<string>"
},
"positiveActiveEnergyPhases": {
"l1": 123,
"l2": 123,
"l3": 123,
"total": 123,
"unit": "<string>"
},
"positiveActiveInstantaneousPower": {
"l1": 123,
"l2": 123,
"l3": 123,
"total": 123,
"unit": "<string>"
},
"positiveGasVolume": {
"unit": "<string>",
"value": 123
},
"positiveReactiveEnergy": {
"t1": 123,
"t2": 123,
"t3": 123,
"t4": 123,
"total": 123,
"unit": "<string>"
},
"range": {
"unit": "<string>",
"value": 123
},
"stateOfCharge": {
"unit": "<string>",
"value": 123
}
},
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"measured": "2023-11-07T05:31:56Z",
"processed": "2023-11-07T05:31:56Z",
"received": "2023-11-07T05:31:56Z"
}
],
"links": {
"next": "<string>"
},
"meta": {
"continuationToken": "<string>",
"pageSize": 123
}
}
Authorizations
Access Token Authentication
Path Parameters
The id of the Entity
Query Parameters
The start of the time frame
The end of the time frame
When possible the Readings will be resampled to the provided resolution
The number of Readings per page
The token used to retrieve the next page
Response
200
application/json
OK
A page of readings.
Was this page helpful?
curl --request GET \
--url https://platform.realto.io/api/v1/entities/{entityId}/readings \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"data": {
"instantaneousCurrent": {
"l1": 123,
"l2": 123,
"l3": 123,
"total": 123,
"unit": "<string>"
},
"instantaneousVoltage": {
"l1": 123,
"l2": 123,
"l3": 123,
"total": 123,
"unit": "<string>"
},
"isCharging": true,
"isPluggedIn": true,
"location": {
"address": "<string>",
"latitude": 123,
"longitude": 123
},
"locationMatches": [
{
"accuracy": 123,
"location": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>"
}
}
],
"negativeActiveEnergy": {
"t1": 123,
"t2": 123,
"t3": 123,
"t4": 123,
"total": 123,
"unit": "<string>"
},
"negativeActiveEnergyPhases": {
"l1": 123,
"l2": 123,
"l3": 123,
"total": 123,
"unit": "<string>"
},
"negativeActiveInstantaneousPower": {
"l1": 123,
"l2": 123,
"l3": 123,
"total": 123,
"unit": "<string>"
},
"negativeGasVolume": {
"unit": "<string>",
"value": 123
},
"odometer": {
"unit": "<string>",
"value": 123
},
"positiveActiveEnergy": {
"t1": 123,
"t2": 123,
"t3": 123,
"t4": 123,
"total": 123,
"unit": "<string>"
},
"positiveActiveEnergyPhases": {
"l1": 123,
"l2": 123,
"l3": 123,
"total": 123,
"unit": "<string>"
},
"positiveActiveInstantaneousPower": {
"l1": 123,
"l2": 123,
"l3": 123,
"total": 123,
"unit": "<string>"
},
"positiveGasVolume": {
"unit": "<string>",
"value": 123
},
"positiveReactiveEnergy": {
"t1": 123,
"t2": 123,
"t3": 123,
"t4": 123,
"total": 123,
"unit": "<string>"
},
"range": {
"unit": "<string>",
"value": 123
},
"stateOfCharge": {
"unit": "<string>",
"value": 123
}
},
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"measured": "2023-11-07T05:31:56Z",
"processed": "2023-11-07T05:31:56Z",
"received": "2023-11-07T05:31:56Z"
}
],
"links": {
"next": "<string>"
},
"meta": {
"continuationToken": "<string>",
"pageSize": 123
}
}