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

# List balances

> Permissions required: **Execute trades** or **Read trade activity**

Get the list of balances.



## OpenAPI

````yaml /knowledge-base/openapi/v4.yaml get /accounts/{accountId}/balances
openapi: 3.1.0
info:
  title: Anchorage Digital Account APIs (v4)
  version: 4.0.0-beta
  description: >-
    Reference for the Anchorage Digital v4 API, the surface behind Crypto as a
    Service: account management (accounts and the account tree, beneficiaries,
    freeze/unfreeze/close), balances and transactions, trusted destinations,
    orders and allocations, withdrawals, deposit instructions, deposit
    attributions, the policy engine (policies, approval keys), and supported
    asset types. Approval groups, endorsements, compliance profiles, customers
    (onboarding), fee configuration updates, interest enrollment, funding
    allocations, and destination removal are under construction and return
    mocked data only.


    Status: BETA. The v4 API is available in the sandbox only
    (https://api.anchorage-staging.com/v4) and is not available in production
    yet. The contract may change until general availability. Which endpoints are
    live, in final testing, or under construction:
    https://docs.anchorage.com/platform/developers/caas/caas-overview


    Authentication: every request carries an `Api-Access-Key` header. Every
    POST, PATCH, and DELETE additionally requires an `Idempotency-Key`, and is
    signed with `Api-Signature` (hex-encoded Ed25519 over
    `timestamp_epoch_seconds + uppercase(http_method) + request_path +
    request_body`) plus `Api-Timestamp` (unix epoch seconds).


    Pagination: list endpoints accept `after` (cursor) and `limit` (page size, 1
    to 1000, default 100) and return a `page.endCursor` to continue from. Errors
    use a common envelope with a human-readable `message`; batch endpoints
    return a result per item instead.


    Guides: https://docs.anchorage.com/platform/developers/caas/caas-overview
servers:
  - url: https://api.anchorage-staging.com/v4
security:
  - Api-Access-Key: []
tags:
  - name: Accounts
  - name: Compliance Profiles
  - name: Balances
  - name: Transactions
  - name: Trusted Destinations
  - name: Orders & Allocations
  - name: Withdrawals
  - name: Deposit Instructions
  - name: Deposit Attributions
  - name: Policies
  - name: Approval Groups
  - name: Endorsements
  - name: Customers
  - name: Asset Types
paths:
  /accounts/{accountId}/balances:
    get:
      tags:
        - Balances
      summary: List balances
      description: |-
        Permissions required: **Execute trades** or **Read trade activity**

        Get the list of balances.
      operationId: listAccountBalances
      parameters:
        - in: query
          description: >-
            When paginating this is used to provide the starting point for the
            page to fetch (retrieved from the previous response body)
          name: after
          schema:
            type: string
            minLength: 1
        - in: query
          name: limit
          schema:
            maximum: 1000
            default: 100
            type: integer
            format: int64
            minimum: 1
          description: Maximum number of results to return per query
        - name: accountId
          in: path
          schema:
            type: string
            format: uuid
            example: 3486b413-93d3-4447-afce-2b9c9dc34a32
          required: true
          description: Account ID or subaccount ID (a UUID).
        - name: asOf
          in: query
          required: false
          schema:
            type: string
            format: date-time
            example: '2019-01-02T12:34:56.000Z'
          description: >-
            The date and time, and includes all balances as of the provided
            instant. The earliest valid value is `2017-01-01T00:00:00Z`. Values
            must be in UTC [RFC
            3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6)
            'date-time' format.
      responses:
        '200':
          description: A list of balances
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountBalancesResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
components:
  schemas:
    AccountBalancesResponse:
      title: Account Balances Response
      type: object
      required:
        - data
        - page
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AccountAssetBalance'
        page:
          $ref: '#/components/schemas/Page'
    ErrorDetails:
      title: ErrorDetails
      type: object
      properties:
        message:
          description: A human-readable message providing more details about the error.
          example: Missing required field 'amount'.
          type: string
      required:
        - message
    AccountAssetBalance:
      title: Account Asset Balance
      type: object
      properties:
        accountId:
          description: Unique Identifier for the account/subaccount
          type: string
          example: ec761b5e-fd2c-497a-a9a0-f8738ac97bdf
        assetType:
          description: >-
            A string representing a type of asset, which usually corresponds to
            the asset's ticker symbol. Use `/asset-types` to list all of the
            supported asset types for your organization.
          example: BTC
          type: string
        price:
          description: >-
            A recent assessment of the intra-day USD value of 1 unit of this
            asset type. This value is provided for convenience for such use
            cases as estimating point-in-time portfolio balances. This value
            does not represent authoritative pricing information used by
            Anchorage Digital for any purpose. The price is fetched as of the
            present, and may be omitted in certain contexts where more
            structured pricing information is provided (e.g. quotes and trades).
          type: string
          example: '9751.01'
        amounts:
          type: array
          items:
            $ref: '#/components/schemas/BalanceAmount'
      required:
        - accountId
        - assetType
        - price
        - amounts
    Page:
      title: Page
      description: Pagination info
      type: object
      properties:
        endCursor:
          description: Submit this parameter in the "after" field to fetch the next page.
          type: string
          nullable: true
    BalanceAmount:
      title: Balance Amount
      description: >
        An amount of a crypto-asset represented by quantity, assetType, current
        unit price and current USD value.



        Fee amounts will be estimates if a transaction is not final.



        NOTE: price and USD value information is recent but does not reflect
        real-time data.
      type: object
      properties:
        balanceType:
          type: string
          example: Balance Type
        quantity:
          description: The numeric value of this amount, excluding units
          example: '10.45234733'
          type: string
          pattern: ^\d+(\.\d+)?$
        usdValue:
          description: >-
            The result of `quantity * currentPrice`, rounded to the nearest
            cent. A unitless number implicitly denominated in dollars. See
            `currentPrice` for methodology and disclaimers.
          type: string
          example: '101920.94'
      required:
        - balanceType
        - quantity
        - usdValue
  securitySchemes:
    Api-Access-Key:
      type: apiKey
      name: Api-Access-Key
      in: header
      description: An API key associated with a security role

````

## Related topics

- [Balances](https://docs.anchorage.com/knowledge-base/platform/developers/caas/caas-balances.md)
- [List trading account balances](https://docs.anchorage.com/knowledge-base/porto/api-reference/v2/trading/list-trading-account-balances.md)
- [Report on ETF balances and transactions](https://docs.anchorage.com/knowledge-base/platform/developers/etf/etf-subledger-reporting.md)
- [Pectra staking](https://docs.anchorage.com/knowledge-base/platform/developers/staking/eth-pectra-staking.md)
