---
updatedAt: 2026-03-31T12:12:41.000Z
agentTools:
projectIndex: https://api.net2grid.com/llms.txt
---
# /meterreader/status
Returns the meter reader type and the connection of the meter with the meter reader.
# OpenAPI definition
```json
{
"openapi": "3.0.0",
"info": {
"title": "NET2GRID Customer Engagement API",
"description": "This is the B2C NET2GRID API that can be used by mobile and web apps to manage the accounts and the data that are provided by the NET2GRID Meter Data Analytics Platform.",
"version": "13.6.0"
},
"servers": [
{
"url": "http://api.net2grid.docker",
"description": "API server"
}
],
"paths": {
"/v2/meterreader/status": {
"get": {
"tags": [
"Registration"
],
"summary": "/meterreader/status",
"description": "Returns the meter reader type and the connection of the meter with the meter reader.",
"operationId": "v2getMeterReaderStatus",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/MeterReaderStatusSmartReaderResponseDTO"
},
{
"$ref": "#/components/schemas/MeterReaderStatusEmptyResponseDTO"
}
]
},
"examples": {
"GetMeterReaderStatusSmartReaderResponse": {
"$ref": "#/components/examples/GetMeterReaderStatusSmartReaderResponse"
},
"GetMeterReaderStatusEmptyResponse": {
"$ref": "#/components/examples/GetMeterReaderStatusEmptyResponse"
}
}
}
}
},
"400": {
"description": "Bad request\n
113: Gateway not found.\n
152: User does not have a valid household object.\n
153: No valid meter found for user.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDTO"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
}
},
"components": {
"schemas": {
"ElectricityEmptyDTO": {
"properties": {
"electricity": {
"type": "array",
"items": {
"type": "string"
}
},
"timestamp": {
"description": "Timestamp of response in ISO-8601 format.",
"type": "string"
}
},
"type": "object"
},
"ElectricitySmartReaderDTO": {
"properties": {
"electricity": {
"$ref": "#/components/schemas/SmartReaderDTO"
},
"timestamp": {
"description": "Timestamp of response in ISO-8601 format.",
"type": "string"
}
},
"type": "object"
},
"MeterReaderStatusEmptyResponseDTO": {
"properties": {
"status": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/ElectricityEmptyDTO"
}
},
"type": "object"
},
"MeterReaderStatusSmartReaderResponseDTO": {
"properties": {
"status": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/ElectricitySmartReaderDTO"
}
},
"type": "object"
},
"SmartReaderAttributesDTO": {
"properties": {
"meter_id_read": {
"description": "The meter ID reported by the gateway.",
"type": "string"
},
"meter_id_provisioned": {
"description": "The customer’s meter ID.",
"type": "string"
},
"pin_entry_mode": {
"description": "The actions/modes that can unlock the meter and enable it.\n1. optical: The meter can be unlocked via the optical interface of the smart reader without any user intervention. \n2. manual_push_button: The meter can be unlocked via manual user intervention, using the relevant button(s) on the meter itself. \n3. manual_torch: The meter can be unlocked by the end user, via light signals from a torch or a flashlight. \n4. NA: The meter doesn't have to be unlocked or this feature is irrelevant to the existing meter. \n5. unknown: The unlocking procedure of the meter is unknown to NET2GRID. ",
"type": "string",
"enum": [
"optical",
"manual_push_button",
"manual_torch",
"NA",
"unknown"
]
},
"pincode": {
"description": "The pincode that is set and reported by the gateway.",
"type": "string"
},
"mode": {
"description": "The reporting mode that the meter reader uses to report data to the platform.",
"type": "string",
"enum": [
"RT",
"AMR",
"RT_INACTIVE",
"LC",
"STATUS",
"THRESHOLD",
"UNKNOWN"
]
},
"key_retries": {
"description": "The number of completed attempts to unlock the meter automatically, via the optical interface. The device will\nperform up to seven automatic unlocks before it stops.",
"type": "string"
},
"meter_unlocked": {
"description": "Signifies whether the meter is unlocked or not.",
"type": "boolean"
},
"signal_strength": {
"description": "Downlink Signal Strength.",
"type": "integer"
},
"battery_status": {
"description": "The state of the battery:\n0: external power supply \n1: Alarm \n2: Low \n3: Okay \n4: Good \n5: Excellent",
"type": "integer",
"enum": [
"0",
"1",
"2",
"3",
"4",
"5"
]
},
"firmware_status": {
"description": "The firmware status for the meter reader.",
"type": "string",
"enum": [
"OK",
"UPDATE_AVAILABLE",
"CHECKING"
]
},
"firmware_update_progress": {
"description": "The progress of firmware update as integer value 0-100. This field will be displayed only if current_status=UPDATE_INSTALLING.",
"type": "integer"
}
},
"type": "object"
},
"SmartReaderDTO": {
"properties": {
"smartreader": {
"$ref": "#/components/schemas/SmartReaderAttributesDTO"
},
"current_status": {
"description": "The current status of the meter:\n\n- READY_FOR_METER_INCLUSION: The SmartBridge is not connected to the SmartReader.\n- COMMISSION_IN_PROGRESS: The SmartBridge has initiated the process of pairing with the SmartReader.\n- UPDATE_INSTALLING: A firmware update is being installed on the SmartReader. The SmartReader is unreachable until this process completes.\n- CONNECTED_WITH_METER: The SmartBridge receives data from the meter, through the SmartReader.\n- VERIFYING_PIN: The automatic process of unlocking the meter using the PIN code is in progress.\n- PIN_FAILED: The meter unlock process has failed\n- CONTACT_WRONG_METER_SERIAL: The SmartReader is connected to the wrong meter.\n- RADIO_LINK_LOST: The LoRa radio connection between the SmartBridge and the SmartReader is lost.\n- UNKNOWN_ERROR: An unexpected error has occurred. If the problem persists, the user should contact customer support.\n- CONTACT_NO_DATA_FROM_METER: The SmartBridge is connected to the SmartReader but the latter cannot read data from the meter. The user should check if the optical probe is properly attached to the meter.",
"type": "string",
"enum": [
"UPDATE_INSTALLING",
"READY_FOR_METER_INCLUSION",
"COMMISSION_IN_PROGRESS",
"RADIO_LINK_LOST",
"CONNECTED_WITH_METER",
"CONTACT_WRONG_METER_SERIAL",
"CONTACT_NO_DATA_FROM_METER",
"VERIFYING_PIN",
"PIN_FAILED",
"UNKNOWN_ERROR"
]
},
"last_successful_meter_connection_timestamp": {
"description": "A successful meter connection means the SmartBridge has at least once parsed meter data successfully via the\nLoRa direct setup. This timestamp corresponds to the last energy measurement retrieved from the meter via\nthe LoRa direct setup. null will be returned when there was no successful meter connection via this setup in\nthe past. Helps distinguish between onboarding and troubleshooting scenarios. The timestamp is in ISO-8601\nformat.",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"ErrorDTO": {
"properties": {
"code": {
"type": "integer"
},
"message": {
"type": "string"
}
},
"type": "object"
},
"ErrorResponseDTO": {
"properties": {
"status": {
"type": "string"
},
"error": {
"$ref": "#/components/schemas/ErrorDTO"
}
},
"type": "object"
}
},
"examples": {
"GetMeterReaderStatusEmptyResponse": {
"summary": "Meter reader empty response.",
"value": {
"status": "ok",
"data": {
"electricity": []
},
"timestamp": "2026-01-20T14:00:39+01:00"
}
},
"GetMeterReaderStatusSmartReaderResponse": {
"summary": "Meter reader response for SmartReader case.",
"value": {
"status": "ok",
"data": {
"electricity": {
"smartreader": {
"meter_id_read": "1DZG0044037253",
"meter_id_provisioned": "1DZG0044037253",
"pin_entry_mode": "unknown",
"mode": "RT_INACTIVE",
"key_retries": "0",
"meter_unlocked": true,
"signal_strength": -68,
"battery_status": 5,
"firmware_status": "OK"
},
"meter_reader_connection_type": "smartreader",
"current_status": "CONNECTED_WITH_METER",
"last_successful_meter_connection_timestamp": "2026-01-14T11:08:50+01:00"
},
"timestamp": "2026-01-20T14:00:39+01:00"
}
}
}
},
"securitySchemes": {
"bearerAuth": {
"type": "http",
"bearerFormat": "JWT",
"scheme": "bearer"
}
}
},
"tags": [
{
"name": "Registration"
}
],
"x-explorer-enabled": false
}
```