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

# Get address list balances

> Look up balances using the hash returned when an address list was stored.

Use the `hash` returned by [Store address list](https://docs.range.org/platform-api/reference/v2/post-addresses-list.md).


## OpenAPI

````yaml api-reference/platform-api.json get /v2/addresses/list/{hash}/balances
openapi: 3.0.0
info:
  title: Range Platform API
  description: >-
    The Range Platform API for workspace management, counterparties, and
    operational tooling.
  version: 1.7.37
  contact: {}
servers:
  - url: https://api.range.org
    description: Range API Server
security:
  - Authorization: []
  - Authorization: []
tags:
  - name: Address Information
    description: Get information about a crypto address.
  - name: Transfer Enrichments
    description: Attach workspace-scoped notes and categories to transfers.
  - name: Counterparties
    description: Manage external entities, their addresses, bank accounts, and documents.
  - name: Parties
    description: >-
      The workspace entity register: the firm itself, its clients, and its
      counterparties.
paths:
  /v2/addresses/list/{hash}/balances:
    get:
      tags:
        - Address Information
      summary: Get balances for address list
      description: >-
        Returns current balances for all addresses in a stored list. Each
        address entry includes all native and token balances, filtered by the
        workspace's token whitelist by default. Pass show_all=true to restore
        the unfiltered response.
      operationId: getAddressListBalances
      parameters:
        - name: hash
          required: true
          in: path
          description: Transaction hash.
          schema:
            example: '0xe6497e3ee548a3372136af2fcb0696db31fc6cf20260707645068bd3fe97f3c4'
            type: string
        - name: show_all
          required: false
          in: query
          description: >-
            Restores the response to today's unfiltered shape, byte-for-byte,
            ignoring the workspace token whitelist. Never mutates stored
            overrides.
          schema:
            default: false
            type: boolean
      responses:
        '200':
          description: Balances for each address in the list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressListBalancesResponseDto'
        '404':
          description: Address list not found for the given hash.
components:
  schemas:
    AddressListBalancesResponseDto:
      type: object
      properties:
        balances:
          type: array
          items:
            $ref: '#/components/schemas/AddressListBalanceEntryDto'
      required:
        - balances
    AddressListBalanceEntryDto:
      type: object
      properties:
        address:
          type: string
          example: cosmos1abc...
        network:
          type: string
          example: cosmoshub-4
          description: >-
            Canonical Range network slug for on-chain balances (ADR-0003).
            Off-chain accounts (exchange/bank/custodian with no chain) use the
            sentinel `off_chain`.
        assets:
          type: array
          items:
            $ref: '#/components/schemas/AssetBalanceDto'
        hidden_count:
          type: number
          example: 0
          description: >-
            RNG-5741: count of assets the workspace token whitelist removed from
            `assets` above. `0` both when nothing was filtered and when this
            entry genuinely holds nothing — distinguish those with
            `assets.length`. Always `0` when `show_all` was requested. Always
            present, including when nothing was hidden.
        updated_at:
          type: string
          example: '2024-01-01T00:00:00.000Z'
          description: >-
            When these balances were last refreshed. Omitted when never
            refreshed.
        lookup_status:
          type: string
          enum:
            - ok
            - unsupported
            - unavailable
            - partial
          example: ok
          description: >-
            Outcome of this entry's balance lookup. `ok`: fully resolved.
            `partial`: the native balance leg failed but token balances resolved
            and are included. `unavailable`: the lookup failed entirely — retry
            may succeed. `unsupported`: this chain has no readable balance
            source, evaluated before any lookup was attempted for this entry —
            retrying will not help. Always present, including on a fully
            successful lookup. A failure on one entry never affects the status
            of any other entry in the same response.
        reason:
          nullable: true
          description: >-
            Why this entry did not return `ok`. Always present as an explicit
            null on `ok`/`unsupported`; populated on `partial`/`unavailable`.
          type: object
          allOf:
            - $ref: '#/components/schemas/AddressBalanceLookupReasonDto'
      required:
        - address
        - network
        - assets
        - hidden_count
        - lookup_status
        - reason
    AssetBalanceDto:
      type: object
      properties:
        symbol:
          type: string
          example: USDC
          description: Asset ticker / symbol. Always present.
        name:
          type: string
          example: USD Coin
          description: >-
            Human-readable asset name. Always present; falls back to `symbol`
            when a distinct name is unavailable.
        amount:
          type: string
          example: '100.50'
          description: >-
            Quantity in asset units as a decimal string (avoids float precision
            loss).
        usd:
          type: string
          nullable: true
          example: '100.50'
          description: >-
            USD value as a decimal string. `null` means the price is unknown
            (distinct from `"0"`, which is a known zero value).
      required:
        - symbol
        - name
        - amount
        - usd
    AddressBalanceLookupReasonDto:
      type: object
      properties:
        code:
          type: string
          enum:
            - reconnect_required
            - provider_timeout
            - rate_limited
            - authentication_failed
            - provider_unreachable
            - provider_rejected
            - provider_error
            - connection_not_found
            - balance_lookup_failed
            - unclassified_provider_error
            - asset_catalog_unavailable
            - tokens_not_enumerated
          example: provider_timeout
          description: >-
            Stable machine code a client may branch on without string-matching
            prose that may be reworded.
        display:
          type: string
          example: Provider timed out
          description: Human-readable display string for `code`.
      required:
        - code
        - display
  securitySchemes:
    Authorization:
      type: apiKey
      in: header
      name: X-API-KEY
      description: Authorization method required to allow user to access the api endpoints.

````

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