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

# Get user balances



## OpenAPI

````yaml /openapi.json get /user-balances
openapi: 3.0.3
info:
  description: API documentation for Crypto service
  title: Crypto API
  version: 1.0.0
servers:
  - description: Development
    url: https://tag.alfa-bot.com/api/prod/v1
security:
  - apiKeyAuth: []
tags:
  - description: Methods for working with wallets
    name: Wallets
  - description: Methods related to users
    name: User
  - description: Methods for AML verification
    name: AML
  - description: Test methods
    name: Test
  - description: Methods for withdrawal funds
    name: Withdrawal
  - description: Methods for working with transactions
    name: Transactions
  - description: Methods for working with exchange transactions
    name: Exchange
paths:
  /user-balances:
    get:
      tags:
        - User
      summary: Get user balances
      operationId: getUserBalances
      responses:
        '200':
          description: OK - user balances were returned successfully
          content:
            application/json:
              schema:
                type: object
                required:
                  - code
                  - error_code
                  - error_message
                  - data
                properties:
                  code:
                    type: string
                    description: Response code.
                    example: '200'
                  error_code:
                    type: string
                    nullable: true
                    description: >-
                      Application-level error code. Null for successful
                      responses.
                    example: null
                  error_message:
                    type: string
                    nullable: true
                    description: >-
                      Human-readable error message. Null for successful
                      responses.
                    example: null
                  data:
                    $ref: '#/components/schemas/UserBalancesResponse'
              examples:
                userBalances:
                  summary: User balances
                  value:
                    code: '200'
                    error_code: null
                    error_message: null
                    data:
                      user_id: '12345'
                      balances:
                        accounting:
                          eth:
                            ETH:
                              available: 0
                            USDC:
                              available: 0
                          trx:
                            TRX:
                              available: 0
                          trx_eth:
                            USDT:
                              available: 0
                              transit: 0
                              blockchain: 0
                        user:
                          trx:
                            TRX:
                              available: 0
                            USDT:
                              available: 0
                      result: success
        '400':
          description: Bad Request - API key has no permission
          content:
            application/json:
              schema:
                type: object
                required:
                  - code
                  - error_code
                  - error_message
                  - data
                properties:
                  code:
                    type: string
                    description: Response code.
                    example: '400'
                  error_code:
                    type: string
                    nullable: true
                    description: >-
                      Application-level error code. Null for successful
                      responses.
                    example: request
                  error_message:
                    type: string
                    nullable: true
                    description: >-
                      Human-readable error message. Null for successful
                      responses.
                    example: Validation failed
                  data:
                    type: object
                    nullable: true
                    description: Additional error details when available.
                    additionalProperties: true
              examples:
                apiKeyNoPermission:
                  summary: API key has no permission
                  value:
                    code: '400'
                    error_code: system
                    error_message: >-
                      Your api_key does not have permission to perform this
                      action
                    data: null
        '500':
          description: Internal Server Error - system or balance retrieval error
          content:
            application/json:
              schema:
                type: object
                required:
                  - code
                  - error_code
                  - error_message
                  - data
                properties:
                  code:
                    type: string
                    description: Response code.
                    example: '500'
                  error_code:
                    type: string
                    nullable: true
                    description: >-
                      Application-level error code. Null for successful
                      responses.
                    example: system
                  error_message:
                    type: string
                    nullable: true
                    description: >-
                      Human-readable error message. Null for successful
                      responses.
                    example: Validation failed
                  data:
                    type: object
                    nullable: true
                    description: Additional error details when available.
                    additionalProperties: true
              examples:
                systemError:
                  summary: System error
                  value:
                    code: '500'
                    error_code: system
                    error_message: System error
                    data: null
                gettingUserBalancesError:
                  summary: Getting user balances
                  value:
                    code: '500'
                    error_code: system
                    error_message: Getting user balances
                    data: null
components:
  schemas:
    UserBalancesResponse:
      type: object
      required:
        - code
        - data
      properties:
        code:
          type: string
          example: '200'
        data:
          type: object
          required:
            - user_id
            - balances
            - result
          properties:
            user_id:
              type: string
              example: '12345'
            balances:
              type: object
              description: Balances grouped by wallet type, then by network, then by token.
              additionalProperties:
                type: object
                additionalProperties:
                  type: object
                  additionalProperties:
                    $ref: '#/components/schemas/UserBalanceTokenItem'
              example:
                accounting:
                  eth:
                    ETH:
                      available: 0
                    USDC:
                      available: 0
                  trx:
                    TRX:
                      available: 0
                  trx_eth:
                    USDT:
                      available: 0
                      transit: 0
                      blockchain: 0
                user:
                  trx:
                    TRX:
                      available: 0
                    USDT:
                      available: 0
            result:
              type: string
              example: success
    UserBalanceTokenItem:
      type: object
      description: >-
        Token balance values. Some tokens may include additional balance buckets
        depending on wallet/network type.
      properties:
        available:
          type: number
          example: 0
        transit:
          type: number
          example: 0
        blockchain:
          type: number
          example: 0
      additionalProperties:
        type: number
  securitySchemes:
    apiKeyAuth:
      in: header
      name: token
      type: apiKey
      description: Pass your API token in the `token` request header.

````