Getting a Meter

Get a specifc Meter.


GET https://utilityapi.com/api/v2/meters/meter_uid
# Get a Meter
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/meters/1234'
# Get a Meter with fully populated blocks (for utilities that don't expand by default)
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/meters/1234?expand_meter_blocks=true'
Parameter Format Description Example
expand_meter_blocks Boolean Load complete meter block information. This is only for utilities that do not expand Meter blocks by default. For utilities that expand their Meter blocks by default, this parameter is ignored. expand_meter_blocks=true

Returns the Meter object.

// Example result
{
    "uid": "12345",
    "created": "2016-01-01T12:30:24.653422+00:00",
    ...
}
Code Response Format Description
200 Meter Successful request.
401 Error Invalid or missing access_token. See our docs on Authentication for how to properly use your access_token.
404 Error This Meter doesn't exist or you don't have permissions to see it.
429 N/A The request was rate limited. Check the Retry-After response header for how long to wait until retrying the request. Do not expect any specific response format for this error (could be html, json, or nothing).
500 N/A Internal server error. Do not expect any specific response format for this error (could be html, json, or nothing). This error is logged and will be fixed by our engineers.
503 N/A Site is currently down for maintenance. Do not expect any specific response format for this error (could be html, json, or nothing).
504 N/A We tried to build this request but timed out. Please try again later. Do not expect any specific response format for this error (could be html, json, or nothing).