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

# Get Balance

> Returns the customer's account-state summary, in USD.



## OpenAPI

````yaml /openapi/v1.json get /v1/balances
openapi: 3.0.0
info:
  title: ParlayX API
  version: 1.0.0
  description: Aggregated prediction-market trading API
servers:
  - url: https://api.parlayx.com
security:
  - apiKey: []
tags:
  - name: Markets
    description: Discover markets and find cross-venue matches.
  - name: Orders
    description: Submit, inspect, and cancel orders.
  - name: Rebalances
    description: Move funds between venues and track the transfer.
  - name: Balance
    description: Read account balances and funding state.
paths:
  /v1/balances:
    get:
      tags:
        - Balance
      summary: Get Balance
      description: Returns the customer's account-state summary, in USD.
      operationId: getBalance
      responses:
        '200':
          description: Balance found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Balance'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: API key missing, malformed, or not recognized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthError'
              example:
                message: Forbidden
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      x-codeSamples:
        - lang: typescript
          label: TypeScript SDK
          source: >
            import { createClient } from "@parlayx/sdk";


            const client = createClient({ apiKey: process.env.PARLAYX_API_KEY!
            });


            const balance = await client.getBalance();


            console.log("cash:", balance.cash);

            console.log("reserved:", balance.reserved);

            console.log("positions:", balance.positions);
components:
  schemas:
    Balance:
      type: object
      properties:
        cash:
          type: number
          description: >-
            Spendable collateral the customer can deploy into a new order right
            now, in USD.
          example: 51.5
        reserved:
          type: number
          description: >-
            Collateral that is not spendable, in USD. The combination of funds
            still in the wallet but earmarked for a pending action (open orders,
            requested withdrawals/rebalances) and funds already debited and in
            flight (withdrawals/rebalances moving).
          example: 15
        positions:
          type: number
          description: >-
            Indicative midpoint value of open prediction-market positions, in
            USD. Market exposure, not cash. Must be sold or redeemed before it
            is spendable again.
          example: 120
        retrievedAt:
          type: string
          description: >-
            ISO-8601 time the account state was read; balances are read live, so
            this is the freshness stamp.
          example: '2026-06-05T18:30:00.000Z'
      required:
        - cash
        - reserved
        - positions
        - retrievedAt
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              $ref: '#/components/schemas/ApiErrorCode'
            message:
              type: string
              description: Plain-text explanation of the error.
          required:
            - code
            - message
      required:
        - error
    AuthError:
      type: object
      properties:
        message:
          type: string
          description: Plain-text explanation of the authentication error.
      required:
        - message
    ApiErrorCode:
      type: string
      enum:
        - INVALID_REQUEST
        - NOT_FOUND
        - INSUFFICIENT_BALANCE
        - IDEMPOTENCY_CONFLICT
        - ORDER_NOT_CANCELLABLE
        - INTERNAL_ERROR
      description: Stable identifier for the error category.
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key

````