---
title: "Get Structure Battery Banks"
method: GET
path: "/v1/battery_banks/{structure_id}"
tags: ["battery_banks"]
---

# Get Structure Battery Banks

`GET /v1/battery_banks/{structure_id}`

## Request

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

This endpoint returns all battery banks related to a structure.

## Path parameters

- `structure_id` string, required

## Response `200`

Successful Response

- BatteryBankView[]
  - `id` integer, required
  - `name` string, required
  - `systemVoltage` number, required
  - `baselinePowerConsumptionKw` number, required
  - `socCutoffPercent` number, required
  - `individualBatteryCapacityAh` number, required
  - `individualBatteryVoltage` number, required
  - `batteryTechnology` 'LiIon' | 'AGM' | 'Gel' | 'NiCd', required
  - `batterySeries` BatterySeriesView[], required
    - `id` integer, required
    - `installationDate` string, date, required
    - `battery` BatteryView, required
      - `id` integer, required
      - `model` string, required
      - `manufacturer` string, required
      - `terminalType` 'Flat_Terminal' | 'Flat_Small_Terminal' | 'Front_Terminal', required
      - `technology` 'LiIon' | 'AGM' | 'Gel' | 'NiCd', required
      - `voltage` number, required
      - `capacityAh` number, required
      - `yearlyPercentageCapacityFade` number, required
      - `weightKg` number, required
      - `price` number, required
      - `socVoltagePoints` SoCVoltagePointView[], required
        - `voltage` number, required
        - `socPercent` number, required
  - `powerStatus` PowerStatusView, required
    - `backupTimeH` number, required
    - `requiredBackupTimeH` number, required
    - `remainingSoCPercent` number, required
    - `backupStatus` 'MEETS_BACKUP_TIME' | 'BELOW_BACKUP_REQUIREMENT', required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/shapemaker/apis/shapemaker-api.md) - [All operations](https://skmtc.dev/shapemaker/apis/shapemaker-api/llms.txt) - [OpenAPI document](https://skmtc.dev/shapemaker/apis/shapemaker-api/revisions/b8461cf1236c?raw)