SHshapemaker
battery_banks

Get Battery Bank Power Status

This endpoint returns the status of the battery bank. . The power status estimated by simulating the battery bank over time after the Grid Outage. To simulate different scenarios you can pass extra batteries that are not part of the battery bank.

post/v1/battery_banks/{battery_bank_id}/power_status

Request

  • Base URL
    https://api.shapemaker.io (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL: /v1/auth

Path parameters

battery_bank_idinteger required

Request body

integer[] required

Response

Successful Response

backupTimeHnumber required
requiredBackupTimeHnumber required
remainingSoCPercentnumber required
backupStatus'MEETS_BACKUP_TIME' | 'BELOW_BACKUP_REQUIREMENT' required

Changes

No recorded changes to this operation across all 1 revision of this API.