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

# Get balances

> Returns a page of account balances.



## OpenAPI

````yaml /api-reference/clearing-api/rest-api/cbc-spec.json post /api/collateral/balance/get-page
openapi: 3.0.3
info:
  title: Coinbase Clearing REST API
  description: >-
    Read-only queries of Coinbase Clearing LLC (CBC) trades, prices, settlement
    results, event positions, and balances.
  version: 1.0.0
servers:
  - url: https://{host}/cdp-api
    variables:
      host:
        default: host
        description: >-
          Host name for your environment. REST API host names are not published
          yet; environments are described on the Coinbase Clearing Connectivity
          page.
security:
  - bearerAuth: []
tags:
  - name: Trades
    description: Derivative and event trades.
  - name: Prices
    description: Instrument prices.
  - name: Settlement Results
    description: Settlement results for instruments.
  - name: Positions
    description: Event positions.
  - name: Balances
    description: Account balances.
paths:
  /api/collateral/balance/get-page:
    post:
      tags:
        - Balances
      summary: Get balances
      description: Returns a page of account balances.
      operationId: getBalances
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BalanceDecoratedQuery'
            example:
              bookmark: null
              queryArgs:
                balance:
                  accountId:
                    filters:
                      - group: 0
                        operator: EQUALS
                        value: 1001
              rangeLimit: 50
              paging: NEXT_PAGE
      responses:
        '200':
          description: A page of results.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceDecoratedPage'
              example:
                bookmark: eyJsYXN0S2V5IjoiMTAwMSJ9
                content:
                  - balance:
                      accountId: 1001
                      depositedBalance:
                        amount: 100000
                        currency: USDC
                      binaryTradeValue:
                        amount: -50000
                        currency: USDC
                      tradeValue:
                        amount: 25000
                        currency: USDC
                      available:
                        amount: 50000
                        currency: USDC
                      clearingMemberId: 200
                      auditData:
                        lastUpdatedBy: balance-calculator
                        lastUpdatedAt: '2026-07-28T15:00:00.000Z'
                    accountCode: ACC-MAIN-001
                    clearingMemberCode: CM-ALPHA
                atEnd: true
components:
  schemas:
    BalanceDecoratedQuery:
      description: Query request for balances.
      allOf:
        - $ref: '#/components/schemas/PageRequest'
        - type: object
          properties:
            queryArgs:
              description: >-
                Filter and sort arguments. Use `null` to return all results
                unfiltered.
              nullable: true
              allOf:
                - $ref: '#/components/schemas/BalanceDecoratedQueryArgs'
    BalanceDecoratedPage:
      description: Page of balances.
      allOf:
        - $ref: '#/components/schemas/PageResponse'
        - type: object
          properties:
            content:
              type: array
              description: Page of balances.
              items:
                $ref: '#/components/schemas/BalanceDecorated'
    PageRequest:
      type: object
      description: Fields shared by every query request.
      required:
        - rangeLimit
        - paging
      properties:
        bookmark:
          type: string
          nullable: true
          description: >-
            Pagination cursor from the previous response. Use `null` for the
            first page.
          example: null
        rangeLimit:
          type: integer
          format: int32
          description: Maximum number of results per page.
          example: 50
        paging:
          $ref: '#/components/schemas/Paging'
    BalanceDecoratedQueryArgs:
      type: object
      description: Filter and sort arguments for balances. All fields are optional.
      properties:
        balance:
          description: Filters on the balance entity.
          allOf:
            - $ref: '#/components/schemas/BalanceQueryArgs'
        accountCode:
          description: Filter by resolved account code.
          allOf:
            - $ref: '#/components/schemas/StringQueryArg'
        clearingMemberCode:
          description: Filter by resolved clearing member code.
          allOf:
            - $ref: '#/components/schemas/StringQueryArg'
    PageResponse:
      type: object
      description: Fields shared by every query response.
      properties:
        bookmark:
          type: string
          description: Cursor to fetch the next or previous page.
          example: eyJsYXN0S2V5IjoiMTAwMyJ9
        atEnd:
          type: boolean
          description: '`true` when there are no more pages in the current direction.'
          example: false
    BalanceDecorated:
      type: object
      description: Balance with resolved codes.
      properties:
        balance:
          description: Balance entity.
          allOf:
            - $ref: '#/components/schemas/Balance'
        accountCode:
          type: string
          description: Resolved account code.
          example: ACC-MAIN-001
        clearingMemberCode:
          type: string
          description: Resolved clearing member code.
          example: CM-ALPHA
    Paging:
      type: string
      description: Page direction.
      enum:
        - NEXT_PAGE
        - PREVIOUS_PAGE
      example: NEXT_PAGE
    BalanceQueryArgs:
      type: object
      description: Filters on the balance entity. All fields are optional.
      properties:
        accountId:
          description: Filter by account ID.
          allOf:
            - $ref: '#/components/schemas/LongQueryArg'
        depositedBalance:
          description: Filter by deposited balance.
          allOf:
            - $ref: '#/components/schemas/MonetaryAmountQueryArgs'
        binaryTradeValue:
          description: Filter by binary trade value.
          allOf:
            - $ref: '#/components/schemas/MonetaryAmountQueryArgs'
        tradeValue:
          description: Filter by trade value.
          allOf:
            - $ref: '#/components/schemas/MonetaryAmountQueryArgs'
        available:
          description: Filter by available balance.
          allOf:
            - $ref: '#/components/schemas/MonetaryAmountQueryArgs'
        clearingMemberId:
          description: Filter by clearing member ID.
          allOf:
            - $ref: '#/components/schemas/LongQueryArg'
        auditData:
          description: Filter by audit fields.
          allOf:
            - $ref: '#/components/schemas/AuditDataQueryArgs'
    StringQueryArg:
      type: object
      description: Filter and sort argument for a string field.
      properties:
        filters:
          type: array
          description: Filter conditions on this field.
          items:
            $ref: '#/components/schemas/StringFilter'
        sorter:
          $ref: '#/components/schemas/Sorter'
    Balance:
      type: object
      description: Balance entity.
      properties:
        accountId:
          type: integer
          format: int64
          description: ID of the account the balance is related to.
          example: 1001
        depositedBalance:
          description: Total value deposited into the account and available at the ledger.
          allOf:
            - $ref: '#/components/schemas/MonetaryAmount'
          example:
            amount: 100000
            currency: USDC
        binaryTradeValue:
          description: >-
            Collateral reserved for open positions, or unrealized PnL waiting to
            be settled.
          allOf:
            - $ref: '#/components/schemas/MonetaryAmount'
          example:
            amount: -50000
            currency: USDC
        tradeValue:
          description: Total trade value of all unsettled positions on the account.
          allOf:
            - $ref: '#/components/schemas/MonetaryAmount'
          example:
            amount: 25000
            currency: USDC
        available:
          description: Collateral available for withdrawal.
          allOf:
            - $ref: '#/components/schemas/MonetaryAmount'
          example:
            amount: 50000
            currency: USDC
        clearingMemberId:
          type: integer
          format: int64
          description: ID of the clearing member related to the account.
          example: 200
        auditData:
          description: Audit data.
          allOf:
            - $ref: '#/components/schemas/AuditData'
          example:
            lastUpdatedBy: balance-calculator
            lastUpdatedAt: '2026-07-28T15:00:00.000Z'
    LongQueryArg:
      type: object
      description: Filter and sort argument for a 64-bit integer field.
      properties:
        filters:
          type: array
          description: Filter conditions on this field.
          items:
            $ref: '#/components/schemas/LongFilter'
        sorter:
          $ref: '#/components/schemas/Sorter'
    MonetaryAmountQueryArgs:
      type: object
      description: Filters on a monetary amount.
      properties:
        amount:
          description: Filter by amount.
          allOf:
            - $ref: '#/components/schemas/BigDecimalQueryArg'
        currency:
          description: Filter by currency code.
          allOf:
            - $ref: '#/components/schemas/StringQueryArg'
    AuditDataQueryArgs:
      type: object
      description: Filters on audit fields.
      properties:
        lastUpdatedBy:
          description: Filter by the user who last updated the entity.
          allOf:
            - $ref: '#/components/schemas/StringQueryArg'
        lastUpdatedAt:
          description: Filter by when the entity was last updated.
          allOf:
            - $ref: '#/components/schemas/InstantQueryArg'
    StringFilter:
      type: object
      description: Filter condition for a string field.
      required:
        - group
        - operator
        - value
      properties:
        group:
          type: integer
          format: int32
          description: >-
            Filter group. Filters in the same group are combined with AND;
            groups are combined with OR.
          example: 0
        operator:
          type: string
          description: Filter operator.
          enum:
            - EQUALS
            - NOT_EQUALS
            - CONTAINS
            - STARTS_WITH
            - ENDS_WITH
          example: EQUALS
        value:
          type: string
          description: String value to compare.
          example: ACC-5001
    Sorter:
      type: object
      description: Sort configuration for a field.
      properties:
        priority:
          type: integer
          format: int32
          description: Sort priority. A lower value has a higher priority.
          example: 0
        sortingDirection:
          type: string
          description: Sort direction.
          enum:
            - ASCENDING
            - DESCENDING
          example: DESCENDING
    MonetaryAmount:
      type: object
      description: Amount in a currency.
      properties:
        amount:
          type: number
          description: Amount.
          example: 1425
        currency:
          type: string
          description: Currency code.
          example: USDC
    AuditData:
      type: object
      description: Audit data.
      properties:
        lastUpdatedBy:
          type: string
          description: ID of the user who created or last updated the entity.
          example: system
        lastUpdatedAt:
          type: string
          format: date-time
          description: Date and time when the entity was last updated.
          example: '2026-01-15T14:30:00.150Z'
    LongFilter:
      type: object
      description: Filter condition for a 64-bit integer field.
      required:
        - group
        - operator
        - value
      properties:
        group:
          type: integer
          format: int32
          description: >-
            Filter group. Filters in the same group are combined with AND;
            groups are combined with OR.
          example: 0
        operator:
          type: string
          description: Filter operator.
          enum:
            - EQUALS
            - NOT_EQUALS
            - GREATER_THAN
            - GREATER_THAN_OR_EQUALS
            - LESS_THAN
            - LESS_THAN_OR_EQUALS
          example: EQUALS
        value:
          type: integer
          format: int64
          description: Integer value to compare.
          example: 12345
    BigDecimalQueryArg:
      type: object
      description: Filter and sort argument for a decimal field.
      properties:
        filters:
          type: array
          description: Filter conditions on this field.
          items:
            $ref: '#/components/schemas/BigDecimalFilter'
        sorter:
          $ref: '#/components/schemas/Sorter'
    InstantQueryArg:
      type: object
      description: Filter and sort argument for a timestamp field.
      properties:
        filters:
          type: array
          description: Filter conditions on this field.
          items:
            $ref: '#/components/schemas/InstantFilter'
        sorter:
          $ref: '#/components/schemas/Sorter'
    BigDecimalFilter:
      type: object
      description: Filter condition for a decimal field.
      required:
        - group
        - operator
        - value
      properties:
        group:
          type: integer
          format: int32
          description: >-
            Filter group. Filters in the same group are combined with AND;
            groups are combined with OR.
          example: 0
        operator:
          type: string
          description: Filter operator.
          enum:
            - EQUALS
            - NOT_EQUALS
            - GREATER_THAN
            - GREATER_THAN_OR_EQUALS
            - LESS_THAN
            - LESS_THAN_OR_EQUALS
          example: EQUALS
        value:
          type: number
          description: Decimal number to compare.
          example: 142.5
    InstantFilter:
      type: object
      description: Filter condition for a timestamp field.
      required:
        - group
        - operator
        - value
      properties:
        group:
          type: integer
          format: int32
          description: >-
            Filter group. Filters in the same group are combined with AND;
            groups are combined with OR.
          example: 0
        operator:
          type: string
          description: Filter operator.
          enum:
            - EQUALS
            - NOT_EQUALS
            - AFTER
            - AFTER_OR_EQUALS
            - BEFORE
            - BEFORE_OR_EQUALS
          example: EQUALS
        value:
          type: string
          format: date-time
          description: ISO-8601 date-time to compare.
          example: '2026-01-15T14:30:00.123Z'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT generated from a Coinbase Developer Platform (CDP) API key. See CDP
        API key JWT authentication.

````