Skip to main content
GET
/
battery
curl
curl --request GET \
  --url 'https://api.amps.ai/battery' \
  --header 'x-api-key: amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx'
{
  "items": [
    {
      "id": "device_abc123",
      "vendor": "example_vendor_a",
      "sync": {
        "available": true,
        "lastPulledAt": "2026-05-07T09:23:45.000Z"
      },
      "metadata": {
        "model": "Hybrid 5kWh",
        "source": "cache"
      },
      "state": {
        "status": "idle",
        "capacity": 10.4,
        "level": 67,
        "chargeRate": 0,
        "dischargeLimit": 10,
        "currentMode": "auto.balanced"
      },
      "commands": {
        "charge": {
          "type": "set_operation_mode",
          "parameters": {
            "target": {
              "unit": "percent",
              "min": 10,
              "max": 100
            },
            "power": {
              "unit": "kw",
              "min": 0,
              "max": 5
            }
          },
          "execution": [
            "immediate",
            "scheduled",
            "windowed"
          ]
        },
        "discharge": {
          "type": "set_operation_mode",
          "parameters": {
            "target": {
              "unit": "percent",
              "min": 10,
              "max": 100
            }
          },
          "execution": [
            "immediate",
            "scheduled",
            "windowed"
          ]
        },
        "auto.balanced": {
          "type": "set_operation_mode",
          "parameters": {},
          "execution": [
            "immediate",
            "scheduled"
          ]
        }
      }
    },
    {
      "id": "device_xyz789",
      "vendor": "example_vendor_b",
      "sync": {
        "available": true,
        "lastPulledAt": "2026-05-07T09:24:10.000Z"
      },
      "metadata": {
        "model": "Hybrid Gen 2",
        "source": "live"
      },
      "state": {
        "status": "discharging",
        "capacity": 9.5,
        "level": 42,
        "chargeRate": -1.8,
        "dischargeLimit": 10,
        "currentMode": "discharge"
      },
      "commands": {
        "charge": {
          "type": "set_operation_mode",
          "parameters": {
            "target": {
              "unit": "percent",
              "min": 10,
              "max": 100
            }
          },
          "execution": [
            "immediate",
            "scheduled"
          ]
        },
        "discharge": {
          "type": "set_operation_mode",
          "parameters": {
            "target": {
              "unit": "percent",
              "min": 10,
              "max": 100
            }
          },
          "execution": [
            "immediate",
            "scheduled"
          ]
        },
        "idle": {
          "type": "set_operation_mode",
          "parameters": {},
          "execution": [
            "immediate",
            "scheduled"
          ]
        }
      }
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 2,
    "hasMore": false
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.amps.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
userId
string

Filter devices by userId.

Example:

"user_abc123"

​
offset
number

Number of devices to skip (default: 0).

Example:

0

​
limit
number

Maximum number of devices to return (1-50, default: 10).

Example:

10

Response

Battery devices retrieved successfully.

​
items
object[]
required
​
pagination
object
required