Get Battery Details

get https://api.derapi.com/batteries/{id}

Returns details for a single Battery

Responses

Response body

object

string

required

Battery id

vendor

string

required

vendor providing this Battery

chargepoint enphase enphasevpp franklinwh sma smasbox solaredge solis tesla virtual

vendorID

string

required

The corresponding ID of the Battery in the vendor's system. Always a string; if the remote type is an integer, this will be a decimal representation of it.

reportedAt

string

required

Date the request was generated in ISO-8601 format (timezone is always +00:00 and is always present)

model

string

required

Model number of Battery

serialNumber

string

required

Manufacturer serial number of the Battery

name

string

Customer defined name of the Battery

siteID

string

required

The Derapi Site ID this Battery is associated with

nameplateKwh

number

The rated storage capacity of the unit

mode

string

Battery management system mode. Values are Self Consumption - minimize grid import, Savings - optimizing Battery to save money; usually based on a rate plan, Backup - only use Battery for grid backup

Self Consumption Savings Backup

stateOfChargePercent

number

Defaults to 20

Battery state of charge as a percent of capacity

recentErrors

array

Most recent errors, warnings, or info reported by the manufacturer for this Battery. The key represents the severity level (info/warning/error); the value is a string description. start is always present and is the last element to be returned.

recentErrors

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.derapi.com/batteries/id \
3
     --header 'accept: application/json'


xxxxxxxxxx
27
}
1
{
2
  "id": "batt-vbte2jglx43tudsj",
3
  "vendor": "virtual",
4
  "vendorID": "123456",
5
  "reportedAt": "2025-08-01T23:59:00+00:00",
6
  "model": "STP 5000TL-20",
7
  "serialNumber": "2233556",
8
  "name": "My Battery",
9
  "siteID": "site-mitpus7brtdd36c2",
10
  "nameplateKwh": 10,
11
  "mode": "Self Consumption",
12
  "stateOfChargePercent": 90,
13
  "recentErrors": [
14
    {
15
      "error": "SPI internal communication failure"
16
    },
17
    {
18
      "warning": "device sensor not detected"
19
    },
20
    {
21
      "info": "info COM A communication status goes to Ok"
22
    },
23
    {
24
      "start": "2025-08-01T23:59:00+00:00"
25
    }

200OK

404A resource wasn't found

422A validation error