> ## 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 wallet list



## OpenAPI

````yaml /openapi.json get /wallets
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:
  /wallets:
    get:
      tags:
        - Wallets
      summary: Get wallet list
      operationId: getWallets
      parameters:
        - in: query
          name: address
          schema:
            type: string
          description: Wallet address filter.
        - in: query
          name: offset
          schema:
            type: integer
          description: Pagination offset.
        - in: query
          name: limit
          schema:
            type: integer
          description: Pagination limit.
        - in: query
          name: type
          schema:
            type: string
          description: Wallet type filter.
        - in: query
          name: network
          schema:
            type: string
          description: Network filter.
      responses:
        '200':
          description: OK - wallet list was 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/GetWalletsResponse'
              examples:
                walletList:
                  summary: Wallet list
                  value:
                    code: '200'
                    error_code: null
                    error_message: null
                    data:
                      user_id: '421304840'
                      count: 89
                      wallets:
                        - balances:
                            BNB:
                              available: 0
                            USDT:
                              available: 5.673420999999998
                          address: '0x09222222222222222222222'
                          name: First BNB Wallet
                          type: accounting
                          network: bnb
                          status: active
                        - balances:
                            ETH:
                              available: 0.184
                            USDT:
                              available: 0
                            USDC:
                              available: 0
                          address: '0x0911111111111111111111111'
                          name: ERC 3
                          type: user
                          network: eth
                          status: active
                          refund:
                            - refund_transaction_id: 1
                              amount: 0.1
                              deposit_transaction_id: '22222'
                              refund_wallet: '0x09222222222222222222222'
                              currency: ETH
        '400':
          description: >-
            Bad Request - API key does not have permission to perform this
            action
          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:
                permissionDenied:
                  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
        '404':
          description: Not Found - wallets could not be found
          content:
            application/json:
              schema:
                type: object
                required:
                  - code
                  - error_code
                  - error_message
                  - data
                properties:
                  code:
                    type: string
                    description: Response code.
                    example: '404'
                  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:
                getWalletsError:
                  summary: Get wallets error
                  value:
                    code: '404'
                    error_code: not_found
                    error_message: Get wallets error
                    data: null
        '500':
          description: Internal Server Error - system 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
components:
  schemas:
    GetWalletsResponse:
      type: object
      required:
        - code
        - data
      properties:
        code:
          type: string
          example: '200'
        data:
          type: object
          required:
            - user_id
            - count
            - wallets
          properties:
            user_id:
              type: string
              example: '421304840'
            count:
              type: integer
              example: 89
            wallets:
              type: array
              items:
                $ref: '#/components/schemas/WalletListItem'
    WalletListItem:
      type: object
      required:
        - balances
        - address
        - name
        - type
        - network
        - status
      properties:
        balances:
          type: object
          description: >-
            Token balances by currency code. Each key is a token ticker, for
            example USDT, USDC, ETH, BNB.
          additionalProperties:
            $ref: '#/components/schemas/WalletBalanceItem'
          example:
            BNB:
              available: 0
            USDT:
              available: 5.673420999999998
        address:
          type: string
          example: '0x09222222222222222222222'
        name:
          type: string
          example: First BNB Wallet
        type:
          type: string
          example: accounting
        network:
          type: string
          example: bnb
        status:
          type: string
          example: active
    WalletBalanceItem:
      type: object
      required:
        - available
      properties:
        available:
          type: number
          example: 5.673420999999998
      additionalProperties: false
  securitySchemes:
    apiKeyAuth:
      in: header
      name: token
      type: apiKey
      description: Pass your API token in the `token` request header.

````