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

# List balances

> Returns available and locked balances, optionally filtered to one asset.

Requires the `ACCOUNT_READ` scope.




## OpenAPI

````yaml /openapi.yaml get /balances
openapi: 3.1.0
info:
  title: PaperDrill REST API
  version: 1.0.0
  description: >
    Trade PaperDrill credit markets and read live market data.


    Prices, quantities, balances, and other decimal values are encoded as
    strings so clients do not lose precision.
servers:
  - url: https://api.paperdrill.dev/v1
    description: Production
security: []
tags:
  - name: Market data
    description: Public markets, tickers, candles, trades, and order-book snapshots.
  - name: Trading
    description: Create, inspect, and cancel orders with a scoped API key.
  - name: Account
    description: Read balances, portfolio performance, and private trade history.
paths:
  /balances:
    get:
      tags:
        - Account
      summary: List balances
      description: |
        Returns available and locked balances, optionally filtered to one asset.

        Requires the `ACCOUNT_READ` scope.
      operationId: listBalances
      parameters:
        - name: asset
          in: query
          description: Return this asset only.
          schema:
            type: string
          example: USD
      responses:
        '200':
          description: Balances returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Balances'
              example:
                USD:
                  available: '9748.50'
                  locked: '251.50'
                SOL:
                  available: '2.00'
                  locked: '0.00'
        '404':
          $ref: '#/components/responses/AssetNotFound'
        default:
          $ref: '#/components/responses/RequestError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    Balances:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/Balance'
    Balance:
      type: object
      required:
        - available
        - locked
      properties:
        available:
          $ref: '#/components/schemas/DecimalString'
        locked:
          $ref: '#/components/schemas/DecimalString'
    ApiError:
      type: object
      required:
        - error
        - requestId
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: array
              items:
                $ref: '#/components/schemas/ApiErrorDetail'
        requestId:
          type: string
          format: uuid
      example:
        error:
          code: VALIDATION_ERROR
          message: Request validation failed
          details:
            - field: qty
              message: invalid decimal format
        requestId: f4c0baf4-b8d2-4c9a-a17b-c8656c4a7b0e
    DecimalString:
      type: string
      pattern: ^\d+(\.\d+)?$
      description: A non-negative decimal encoded as a string.
      example: '125.50'
    ApiErrorDetail:
      type: object
      required:
        - message
      properties:
        field:
          type: string
        message:
          type: string
  responses:
    AssetNotFound:
      description: The requested asset does not exist.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    RequestError:
      description: The request failed. See Errors and rate limits for recovery guidance.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: A scoped API key created in the PaperDrill dashboard.

````

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