> ## Documentation Index
> Fetch the complete documentation index at: https://docs.luxxon.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get wallet state

> Workspace wallet snapshot: tracked balance + allowance + last synced block. Balance authority lives on Base; this is a watcher-maintained cache.



## OpenAPI

````yaml /openapi.json get /api/v1/wallet
openapi: 3.0.0
info:
  title: Luxxon API
  description: Programmable vision — on-demand live video feeds
  version: 0.1.0
  contact: {}
servers:
  - url: https://api.luxxon.dev/api/v1
security: []
tags:
  - name: Authentication
    description: SIWE wallet sign-in. Used by the dashboard; API-key callers skip this.
  - name: Me
    description: Identity self-introspection — wallet or API key.
  - name: Workspaces
    description: Tenant root. Coverage area, availability, members.
  - name: API keys
    description: Per-workspace scoped credentials (lxxn_*).
  - name: Pricing
    description: Live rate + optional pre-quoted rate lock.
  - name: Sessions
    description: 'Visual session lifecycle: request → dispatch → authorize → start → end.'
  - name: Wallet
    description: On-chain wallet state and event log for a workspace.
  - name: Settlements
    description: On-chain settlement view per session.
  - name: Health
    description: Proof-of-life. No auth.
  - name: Webhooks
    description: Inbound video events from Cloudflare Stream. Internal.
paths:
  /api/v1/wallet:
    get:
      tags:
        - Wallet
      summary: Get wallet state
      description: >-
        Workspace wallet snapshot: tracked balance + allowance + last synced
        block. Balance authority lives on Base; this is a watcher-maintained
        cache.
      operationId: LxWalletController_getState
      parameters:
        - name: x-lx-consistency-token
          required: false
          in: header
          schema:
            type: string
        - name: workspaceId
          required: false
          in: query
          schema:
            example: 8c3a5b6f-1d2e-4f7a-9b8c-d1e2f3a4b5c6
      responses:
        '200':
          description: Request successful
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/LxSuccessResponseDto'
                  - properties:
                      data:
                        $ref: '#/components/schemas/LxWalletStateDto'
        '400':
          description: INVALID_INPUT
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LxErrorResponseDto'
              examples:
                INVALID_INPUT:
                  summary: INVALID_INPUT — Invalid request payload
                  value:
                    statusCode: 400
                    code: INVALID_INPUT
                    message: Invalid request payload
                    detail: invalid_input:example
                    timestamp: '2026-05-13T12:00:00.000Z'
        '401':
          description: NOT_AUTHENTICATED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LxErrorResponseDto'
              examples:
                NOT_AUTHENTICATED:
                  summary: NOT_AUTHENTICATED — Session expired or missing
                  value:
                    statusCode: 401
                    code: NOT_AUTHENTICATED
                    message: Session expired or missing
                    detail: not_authenticated:example
                    timestamp: '2026-05-13T12:00:00.000Z'
        '403':
          description: NOT_AUTHORIZED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LxErrorResponseDto'
              examples:
                NOT_AUTHORIZED:
                  summary: NOT_AUTHORIZED — Not authorized for this operation
                  value:
                    statusCode: 403
                    code: NOT_AUTHORIZED
                    message: Not authorized for this operation
                    detail: not_authorized:example
                    timestamp: '2026-05-13T12:00:00.000Z'
        '404':
          description: NOT_FOUND
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LxErrorResponseDto'
              examples:
                NOT_FOUND:
                  summary: NOT_FOUND — Resource not found
                  value:
                    statusCode: 404
                    code: NOT_FOUND
                    message: Resource not found
                    detail: not_found:example
                    timestamp: '2026-05-13T12:00:00.000Z'
        '503':
          description: AUTHZ_ERROR, DATABASE_ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LxErrorResponseDto'
              examples:
                DATABASE_ERROR:
                  summary: DATABASE_ERROR — Database unavailable
                  value:
                    statusCode: 503
                    code: DATABASE_ERROR
                    message: Database unavailable
                    detail: database_error:example
                    timestamp: '2026-05-13T12:00:00.000Z'
                AUTHZ_ERROR:
                  summary: AUTHZ_ERROR — Authorization service unavailable
                  value:
                    statusCode: 503
                    code: AUTHZ_ERROR
                    message: Authorization service unavailable
                    detail: authz_error:example
                    timestamp: '2026-05-13T12:00:00.000Z'
      security:
        - access-token: []
components:
  schemas:
    LxSuccessResponseDto:
      type: object
      properties:
        statusCode:
          type: number
          example: 200
        message:
          type: string
          example: Request successful
        data:
          type: object
          description: Endpoint-specific payload. See the per-endpoint schema.
        timestamp:
          type: string
          example: '2026-05-13T12:00:00.000Z'
      required:
        - statusCode
        - message
        - data
        - timestamp
    LxWalletStateDto:
      type: object
      properties:
        workspaceId:
          type: string
          example: 8c3a5b6f-1d2e-4f7a-9b8c-d1e2f3a4b5c6
        walletAddress:
          type: string
          example: '0xAbC0000000000000000000000000000000000001'
        trackedBalance:
          type: string
          example: '500000'
          description: Watcher-snapshot balance in µUSDC.
        lastSyncBlock:
          type: string
          example: '12345678'
          description: Last on-chain block synced.
        updatedAt:
          type: string
          example: '2026-05-13T11:30:00.000Z'
      required:
        - workspaceId
        - walletAddress
        - trackedBalance
        - lastSyncBlock
        - updatedAt
    LxErrorResponseDto:
      type: object
      properties:
        statusCode:
          type: number
          example: 400
        code:
          type: string
          example: INVALID_INPUT
          description: Machine-readable error code — see ErrorCodes.
        message:
          type: string
          example: Invalid request payload
        detail:
          type: string
          example: session:workspaceMismatch
          description: Short, safe-to-expose label scoping the failure site.
        timestamp:
          type: string
          example: '2026-05-13T12:00:00.000Z'
      required:
        - statusCode
        - code
        - message
        - timestamp
  securitySchemes:
    access-token:
      scheme: bearer
      bearerFormat: JWT or lxxn_*
      type: http

````