> ## 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.

# Get Solar Inverter state

> Retrieve the current state of a solar inverter device including power production, status, and energy totals



## OpenAPI

````yaml /openapi.json get /solar-inverter/{deviceId}
openapi: 3.1.0
info:
  title: Amps.ai API
  description: >-
    Energy device management API for batteries, EV chargers, solar inverters,
    and HVAC systems
  version: '1.0'
  contact: {}
servers:
  - url: https://api.amps.ai
    description: Amps API
security: []
tags: []
paths:
  /solar-inverter/{deviceId}:
    get:
      tags:
        - Solar Inverter
      summary: Get Solar Inverter state
      description: >-
        Retrieve the current state of a solar inverter device including power
        production, status, and energy totals
      operationId: getSolarInverter
      parameters:
        - name: expedite
          required: false
          in: query
          description: >-
            Use a shorter cache lifetime, subject to manufacturer read limits.
            Check sync.expeditedRefetchAfter for the earliest known refresh
            time.
          schema:
            example: true
            type: boolean
        - name: deviceId
          required: true
          in: path
          description: The unique identifier for the solar inverter device
          schema:
            example: device_abc123
            type: string
      responses:
        '200':
          description: Solar Inverter state retrieved successfully
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                  - meta
                properties:
                  success:
                    type: boolean
                    const: true
                    description: Always `true` for success responses.
                  data:
                    $ref: '#/components/schemas/SolarInverterResponse'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
              examples:
                inverterGenerating:
                  summary: Inverter generating during the day
                  description: >-
                    `status: producing`, `producing: true`, and `currentPower`
                    reflects live AC output. Mid-morning sunlight; output is
                    climbing toward midday peak.
                  value:
                    success: true
                    data:
                      id: device_inverter_001
                      vendor: example_vendor_a
                      sync:
                        source: live
                        deviceReportedAt: null
                        fetchedAt: '2026-05-07T10:23:45.000Z'
                        outdatedBy: null
                        refetchAfter: null
                        expeditedRefetchAfter: null
                        lastFetchAttempt:
                          at: '2026-05-07T10:23:45.000Z'
                          outcome: succeeded
                      model: Hybrid 5kW
                      state:
                        status: producing
                        currentPower: 3.8
                        producing: true
                        energyTotal: 11540.6
                    meta:
                      requestId: req_8a2Bf3kP
                      environment: sandbox
                      timestamp: '2026-06-02T12:00:00.000Z'
                      latencyMs: 12
                inverterAtPeak:
                  summary: Inverter at peak midday output
                  description: >-
                    Mid-day clear sky, near-rated output. `currentPower` close
                    to the device-rated maximum.
                  value:
                    success: true
                    data:
                      id: device_inverter_001
                      vendor: example_vendor_a
                      sync:
                        source: live
                        deviceReportedAt: null
                        fetchedAt: '2026-05-07T13:00:00.000Z'
                        outdatedBy: null
                        refetchAfter: null
                        expeditedRefetchAfter: null
                        lastFetchAttempt:
                          at: '2026-05-07T13:00:00.000Z'
                          outcome: succeeded
                      model: Hybrid 5kW
                      state:
                        status: producing
                        currentPower: 4.9
                        producing: true
                        energyTotal: 11543.2
                    meta:
                      requestId: req_8a2Bf3kP
                      environment: sandbox
                      timestamp: '2026-06-02T12:00:00.000Z'
                      latencyMs: 12
                inverterPartialOutput:
                  summary: Inverter producing reduced output (cloud cover)
                  description: >-
                    Cloud cover or partial shading reduces output well below the
                    rated maximum, but the inverter is still producing.
                  value:
                    success: true
                    data:
                      id: device_inverter_001
                      vendor: example_vendor_a
                      sync:
                        source: live
                        deviceReportedAt: null
                        fetchedAt: '2026-05-07T11:30:00.000Z'
                        outdatedBy: null
                        refetchAfter: null
                        expeditedRefetchAfter: null
                        lastFetchAttempt:
                          at: '2026-05-07T11:30:00.000Z'
                          outcome: succeeded
                      model: Hybrid 5kW
                      state:
                        status: producing
                        currentPower: 1.2
                        producing: true
                        energyTotal: 11541.8
                    meta:
                      requestId: req_8a2Bf3kP
                      environment: sandbox
                      timestamp: '2026-06-02T12:00:00.000Z'
                      latencyMs: 12
                inverterIdleAtNight:
                  summary: Inverter in night mode
                  description: >-
                    `status: night_mode` with `producing: false` and zero power.
                    Lifetime `energyTotal` carries through unchanged.
                  value:
                    success: true
                    data:
                      id: device_inverter_001
                      vendor: example_vendor_a
                      sync:
                        source: stored
                        deviceReportedAt: null
                        fetchedAt: '2026-05-07T22:00:00.000Z'
                        outdatedBy: null
                        refetchAfter: null
                        expeditedRefetchAfter: null
                        lastFetchAttempt: null
                      model: Hybrid 5kW
                      state:
                        status: night_mode
                        currentPower: 0
                        producing: false
                        energyTotal: 11550.4
                    meta:
                      requestId: req_8a2Bf3kP
                      environment: sandbox
                      timestamp: '2026-06-02T12:00:00.000Z'
                      latencyMs: 12
                inverterIdleDaytime:
                  summary: Inverter idle during daytime (clipped or curtailed)
                  description: >-
                    Daytime but `status: idle`. Often a curtailment scenario
                    (export limit, battery full, or grid-tied protection) where
                    the inverter is online but not producing.
                  value:
                    success: true
                    data:
                      id: device_inverter_001
                      vendor: example_vendor_a
                      sync:
                        source: live
                        deviceReportedAt: null
                        fetchedAt: '2026-05-07T14:00:00.000Z'
                        outdatedBy: null
                        refetchAfter: null
                        expeditedRefetchAfter: null
                        lastFetchAttempt:
                          at: '2026-05-07T14:00:00.000Z'
                          outcome: succeeded
                      model: Hybrid 5kW
                      state:
                        status: idle
                        currentPower: 0
                        producing: false
                        energyTotal: 11546.2
                    meta:
                      requestId: req_8a2Bf3kP
                      environment: sandbox
                      timestamp: '2026-06-02T12:00:00.000Z'
                      latencyMs: 12
                inverterOffline:
                  summary: Inverter unreachable
                  description: >-
                    `sync.source: stored` preserves the last reading and its
                    original `sync.fetchedAt`. The failed attempt reports
                    `DEVICE_OFFLINE`.
                  value:
                    success: true
                    data:
                      id: device_inverter_001
                      vendor: example_vendor_a
                      sync:
                        source: stored
                        deviceReportedAt: null
                        fetchedAt: '2026-05-06T22:14:10.000Z'
                        outdatedBy: null
                        refetchAfter: null
                        expeditedRefetchAfter: null
                        lastFetchAttempt:
                          at: '2026-05-06T22:15:10.000Z'
                          outcome: failed
                          errorCode: DEVICE_OFFLINE
                      model: Hybrid 5kW
                      state:
                        status: offline
                        currentPower: 0
                        producing: false
                        energyTotal: 11540.6
                    meta:
                      requestId: req_8a2Bf3kP
                      environment: sandbox
                      timestamp: '2026-06-02T12:00:00.000Z'
                      latencyMs: 12
        '400':
          description: >-
            The device manufacturer rejected the pull request
            (`INVALID_PARAMETERS` or `COMMAND_FAILED`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                missingApiKey:
                  summary: No `x-api-key` header present
                  value:
                    success: false
                    error:
                      code: UNAUTHORIZED
                      message: Authentication is required.
                      details:
                        description: API key is required
                    meta:
                      requestId: req_8sW2dRtX
                      timestamp: '2026-04-29T12:00:00.000Z'
                      path: /solar-inverter/device_inverter_001
                      latencyMs: 2
        '403':
          description: >-
            Live access is disabled, consent is revoked, the device allowance is
            exceeded, or the manufacturer denied access to the device
            (`DEVICE_UNAUTHORIZED`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Device not found or access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                deviceNotFound:
                  summary: No device matches the ID for this customer
                  value:
                    success: false
                    error:
                      code: DEVICE_NOT_FOUND
                      message: No matching device was found for the supplied details.
                      details:
                        description: Device not found or access denied
                    meta:
                      requestId: req_5pH1cQbY
                      timestamp: '2026-04-29T12:00:00.000Z'
                      path: /solar-inverter/device_unknown_999
                      latencyMs: 5
        '502':
          description: >-
            The manufacturer returned an unusable reading
            (`INVALID_OEM_RESPONSE`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: >-
            Amps has temporarily paused this read and refused the request. Retry
            with exponential backoff.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                readPaused:
                  summary: Amps has temporarily paused this read. Retry with backoff.
                  value:
                    success: false
                    error:
                      code: CAPABILITY_PAUSED
                      message: >-
                        Amps has temporarily paused this capability. Try again
                        later.
                    meta:
                      requestId: req_GoQ8uBiI
                      timestamp: '2026-04-29T12:00:00.000Z'
                      path: /solar-inverter/device_inverter_001
                      latencyMs: 1873
      security:
        - api-key: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: |-
            curl --request GET \
              --url 'https://api.amps.ai/solar-inverter/device_abc123' \
              --header 'x-api-key: amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx'
        - lang: javascript
          label: Node
          source: >-
            const response = await
            fetch('https://api.amps.ai/solar-inverter/device_abc123', {
              method: 'GET',
              headers: {
                'x-api-key': 'amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx',
              },
            });


            const data = await response.json();
        - lang: python
          label: Python
          source: |-
            import requests

            url = 'https://api.amps.ai/solar-inverter/device_abc123'
            headers = {
                'x-api-key': 'amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx',
            }

            response = requests.get(url, headers=headers)
            data = response.json()
components:
  schemas:
    SolarInverterResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the solar inverter device.
        vendor:
          type: string
          description: OEM display name (e.g. `enphase`, `solaredge`).
        sync:
          type: object
          properties:
            source:
              type: string
              enum:
                - live
                - stored
                - simulated
                - none
              description: >-
                live: all telemetry fetched for this request. stored: any
                telemetry reused, or a stored reading served after a failure.
                simulated: sandbox state. none: no reading exists.
            deviceReportedAt:
              anyOf:
                - type: string
                  format: date-time
                - type: 'null'
              description: >-
                Time the manufacturer reports for the data, in UTC. Null when
                unavailable.
            fetchedAt:
              anyOf:
                - type: string
                  format: date-time
                - type: 'null'
              description: >-
                Original receipt time of the oldest telemetry used by this
                reading, or null for simulated state or no reading.
            lastFetchAttempt:
              anyOf:
                - type: object
                  properties:
                    at:
                      type: string
                      format: date-time
                      description: When the fetch attempt started, in UTC.
                    outcome:
                      type: string
                      enum:
                        - succeeded
                        - failed
                      description: Whether the fetch attempt succeeded.
                    errorCode:
                      description: Failure code when the fetch attempt failed.
                      type: string
                      enum:
                        - INVALID_CREDENTIALS
                        - INVALID_API_KEY
                        - INVALID_MFA_CODE
                        - MFA_REQUIRED
                        - ACCOUNT_LOCKED
                        - UNSUPPORTED_CREDENTIAL_TYPE
                        - DEVICE_NOT_FOUND
                        - DEVICE_OFFLINE
                        - DEVICE_UNAUTHORIZED
                        - NO_DEVICES_FOUND
                        - COMMAND_FAILED
                        - DEVICE_NOT_CAPABLE
                        - MODE_OVERRIDDEN
                        - VPP_LOCKED
                        - INVALID_PARAMETERS
                        - PARAMETER_REQUIRED
                        - INVALID_OEM_PARAMETERS
                        - INVALID_TIME_WINDOW
                        - BIND_NOT_SUPPORTED
                        - SCHEDULER_ACTIVE
                        - SCHEDULER_FULL
                        - UNSUPPORTED_AUTH_PATH
                        - SETTING_OUT_OF_RANGE
                        - NETWORK_ERROR
                        - RATE_LIMITED
                        - SERVICE_UNAVAILABLE
                        - TIMEOUT
                        - SIMULATED_FAILURE
                        - UNKNOWN_ERROR
                        - VEHICLE_NOT_CONNECTED
                        - CONSENT_REVOKED
                        - CREDENTIAL_NOT_FOUND
                        - CAPABILITY_PAUSED
                        - INVALID_OEM_RESPONSE
                        - COMMAND_NOT_APPLIED
                        - STALE_ACTION
                        - DEFERRED_SCHEDULE_FAILED
                        - UNROUTABLE_ACTION_TYPE
                        - UNAUTHORIZED
                        - EXPIRED_TOKEN
                        - FORBIDDEN
                        - INSUFFICIENT_PERMISSIONS
                        - LIVE_ACCESS_DISABLED
                        - VALIDATION_ERROR
                        - INVALID_INPUT
                        - INVALID_REQUEST_BODY
                        - EMPTY_SETTINGS
                        - PAYLOAD_TOO_LARGE
                        - UNSUPPORTED_MEDIA_TYPE
                        - NOT_FOUND
                        - METHOD_NOT_ALLOWED
                        - CONFLICT
                        - CONFLICT_IN_EXECUTION
                        - GONE
                        - RATE_LIMIT_EXCEEDED
                        - INTERNAL_ERROR
                        - NOT_IMPLEMENTED
                        - BAD_GATEWAY
                        - GATEWAY_TIMEOUT
                        - DEVICE_TYPE_MISMATCH
                        - DEVICE_OVERAGE
                        - SETTINGS_STORE_UNAVAILABLE
                        - ACTION_NOT_FOUND
                        - UNSUPPORTED_PARAMETER_COMBINATION
                        - PARAMETER_OUT_OF_RANGE
                        - START_IN_PAST
                        - START_OUT_OF_RANGE
                        - START_OFFSET_NOT_ACCEPTED
                        - START_INVALID_FORMAT
                        - START_NONEXISTENT_WALL_CLOCK
                        - TIMEZONE_UNRESOLVED
                        - INVALID_TIMEZONE
                        - ACTION_NOT_CANCELLABLE
                        - UNSUPPORTED_SETTING_COMBINATION
                        - INVALID_SETTING_UNIT
                        - INVALID_SETTING_VALUE
                        - NO_OP
                        - NO_OVERRIDE
                        - AVAILABILITY_ENV_UNSUPPORTED
                        - UNSUPPORTED_COMBINATION
                  required:
                    - at
                    - outcome
                - type: 'null'
              description: >-
                Latest completed fetch attempt, ordered by start time. Null for
                simulated state or no recorded attempt.
            outdatedBy:
              anyOf:
                - type: object
                  properties:
                    at:
                      type: string
                      format: date-time
                      description: When the later change through Amps occurred, in UTC.
                    actionId:
                      anyOf:
                        - type: string
                        - type: 'null'
                      description: >-
                        The caller's command or stop action ID. Null for another
                        customer's change or a settings write.
                  required:
                    - at
                    - actionId
                - type: 'null'
              description: >-
                A successful change through Amps after this reading's fetch
                started. It does not prove the device applied the change. Null
                for simulated state, an unknown fetch start or no later known
                change.
            refetchAfter:
              anyOf:
                - type: string
                  format: date-time
                - type: 'null'
              description: >-
                Earliest known time a normal detail read can attempt a
                manufacturer fetch. Null for simulated state or unknown timing.
            expeditedRefetchAfter:
              anyOf:
                - type: string
                  format: date-time
                - type: 'null'
              description: >-
                Earliest known time an expedited detail read can attempt a
                manufacturer fetch. Null for simulated state or unknown timing.
          required:
            - source
            - deviceReportedAt
            - fetchedAt
            - lastFetchAttempt
            - outdatedBy
            - refetchAfter
            - expeditedRefetchAfter
        model:
          type: string
          description: Saved device model name.
        state:
          anyOf:
            - type: object
              properties:
                status:
                  type: string
                  enum:
                    - producing
                    - idle
                    - night_mode
                    - error
                    - offline
                  description: Current operational status of the solar inverter.
                currentPower:
                  type: number
                  description: Current AC power output in kW.
                producing:
                  type: boolean
                  description: Whether the inverter is actively producing power right now.
                energyTotal:
                  type: number
                  description: Lifetime energy production in kWh.
              required:
                - status
                - currentPower
                - producing
                - energyTotal
            - type: 'null'
      required:
        - id
        - vendor
        - sync
        - model
        - state
      title: Solar Inverter Response
    ResponseMeta:
      type: object
      title: Response Meta
      description: >-
        Metadata attached to every response: the request identifier, the serving
        environment, the build timestamp, and the server-side latency.
      required:
        - environment
        - timestamp
        - latencyMs
      properties:
        requestId:
          description: >-
            Unique request identifier. Echoes the `x-request-id` header when
            present; otherwise generated server-side.
          type: string
        environment:
          type: string
          description: The environment that served the request (`sandbox` or `live`).
        timestamp:
          type: string
          format: date-time
          description: ISO 8601 timestamp when the response was built.
        latencyMs:
          type: integer
          description: Server-side processing time in milliseconds.
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Always `false` for error responses.
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - INVALID_CREDENTIALS
                - INVALID_API_KEY
                - INVALID_MFA_CODE
                - MFA_REQUIRED
                - ACCOUNT_LOCKED
                - UNSUPPORTED_CREDENTIAL_TYPE
                - DEVICE_NOT_FOUND
                - DEVICE_OFFLINE
                - DEVICE_UNAUTHORIZED
                - NO_DEVICES_FOUND
                - COMMAND_FAILED
                - DEVICE_NOT_CAPABLE
                - MODE_OVERRIDDEN
                - VPP_LOCKED
                - INVALID_PARAMETERS
                - PARAMETER_REQUIRED
                - INVALID_OEM_PARAMETERS
                - INVALID_TIME_WINDOW
                - BIND_NOT_SUPPORTED
                - SCHEDULER_ACTIVE
                - SCHEDULER_FULL
                - UNSUPPORTED_AUTH_PATH
                - SETTING_OUT_OF_RANGE
                - NETWORK_ERROR
                - RATE_LIMITED
                - SERVICE_UNAVAILABLE
                - TIMEOUT
                - SIMULATED_FAILURE
                - UNKNOWN_ERROR
                - VEHICLE_NOT_CONNECTED
                - CONSENT_REVOKED
                - CREDENTIAL_NOT_FOUND
                - CAPABILITY_PAUSED
                - INVALID_OEM_RESPONSE
                - COMMAND_NOT_APPLIED
                - STALE_ACTION
                - DEFERRED_SCHEDULE_FAILED
                - UNROUTABLE_ACTION_TYPE
                - UNAUTHORIZED
                - EXPIRED_TOKEN
                - FORBIDDEN
                - INSUFFICIENT_PERMISSIONS
                - LIVE_ACCESS_DISABLED
                - VALIDATION_ERROR
                - INVALID_INPUT
                - INVALID_REQUEST_BODY
                - EMPTY_SETTINGS
                - PAYLOAD_TOO_LARGE
                - UNSUPPORTED_MEDIA_TYPE
                - NOT_FOUND
                - METHOD_NOT_ALLOWED
                - CONFLICT
                - CONFLICT_IN_EXECUTION
                - GONE
                - RATE_LIMIT_EXCEEDED
                - INTERNAL_ERROR
                - NOT_IMPLEMENTED
                - BAD_GATEWAY
                - GATEWAY_TIMEOUT
                - DEVICE_TYPE_MISMATCH
                - DEVICE_OVERAGE
                - SETTINGS_STORE_UNAVAILABLE
                - ACTION_NOT_FOUND
                - UNSUPPORTED_PARAMETER_COMBINATION
                - PARAMETER_OUT_OF_RANGE
                - START_IN_PAST
                - START_OUT_OF_RANGE
                - START_OFFSET_NOT_ACCEPTED
                - START_INVALID_FORMAT
                - START_NONEXISTENT_WALL_CLOCK
                - TIMEZONE_UNRESOLVED
                - INVALID_TIMEZONE
                - ACTION_NOT_CANCELLABLE
                - UNSUPPORTED_SETTING_COMBINATION
                - INVALID_SETTING_UNIT
                - INVALID_SETTING_VALUE
                - NO_OP
                - NO_OVERRIDE
                - AVAILABILITY_ENV_UNSUPPORTED
                - UNSUPPORTED_COMBINATION
              description: >-
                Machine-readable error code (e.g. `VALIDATION_ERROR`,
                `CONFLICT`, `DEVICE_NOT_CAPABLE`). Stable across releases; safe
                to switch on.
            message:
              type: string
              description: Human-readable error message.
            details:
              description: >-
                Structured context for the error: which fields were invalid,
                which actions conflicted, which capabilities the device
                declares. Shape varies by error code.
              type: object
              properties: {}
              additionalProperties: {}
          required:
            - code
            - message
          description: Error envelope.
        meta:
          type: object
          properties:
            requestId:
              description: >-
                Unique request identifier. Echoes the `x-request-id` header when
                present; otherwise generated server-side.
              type: string
            timestamp:
              type: string
              description: ISO 8601 timestamp when the error response was built.
            path:
              type: string
              description: Request path that produced the error.
            latencyMs:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
              description: Server-side processing time in milliseconds.
          required:
            - timestamp
            - path
            - latencyMs
          description: Request metadata.
      required:
        - success
        - error
        - meta
      title: Error Response
      description: >-
        Uniform error response. The `error.code` identifies the failure,
        `error.message` carries a human-readable explanation, and
        `error.details` carries structured context (failed fields, conflicting
        action IDs, supported capabilities) where relevant.
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.