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

# Get the balance

> The account's balance, the same figures the dashboard shows. For retail, exposure is full betting liability (including unmatched commitments, lay liability and commission), and available is cashBalance minus exposure. Agent balances retain givenCredit plus cashBalance minus stake exposure.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/balance
openapi: 3.1.0
info:
  title: Apexium Trading API
  version: '1'
  description: Public API, authenticated with an API key in the x-api-key header.
servers:
  - url: https://api.apexiumbet.com
    description: Production
security:
  - apiKey: []
tags:
  - name: Health
    description: Whether the API is up, without an API key
  - name: Account
    description: The account behind the API key and its balance
  - name: Reference data
    description: OddsPapi sports, tournaments, participants, markets and bookmakers
  - name: Fixtures
    description: 'OddsPapi fixtures: schedule, status, scores'
  - name: Odds
    description: OddsPapi odds, limited to the account's bookmakers
  - name: Betslip
    description: >-
      The price and stake limits of one selection at each of the account's
      bookmakers
  - name: Orders
    description: Preview, place, read and cancel orders
  - name: Bets
    description: The bets your orders were split into
  - name: Positions and PnL
    description: Open exposure and realised results
paths:
  /v1/balance:
    get:
      tags:
        - Account
      summary: Get the balance
      description: >-
        The account's balance, the same figures the dashboard shows. For retail,
        exposure is full betting liability (including unmatched commitments, lay
        liability and commission), and available is cashBalance minus exposure.
        Agent balances retain givenCredit plus cashBalance minus stake exposure.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                required:
                  - givenCredit
                  - cashBalance
                  - exposure
                  - available
                properties:
                  givenCredit:
                    description: Money amount
                    type: object
                    required:
                      - amount
                      - amountCents
                      - currency
                    properties:
                      amount:
                        pattern: ^-?\d+\.\d{2}$
                        description: Decimal string, two decimals
                        type: string
                      amountCents:
                        description: 'The same amount in integer cents: amount times 100'
                        type: integer
                      currency:
                        description: ISO 4217 code
                        type: string
                  cashBalance:
                    description: Money amount
                    type: object
                    required:
                      - amount
                      - amountCents
                      - currency
                    properties:
                      amount:
                        pattern: ^-?\d+\.\d{2}$
                        description: Decimal string, two decimals
                        type: string
                      amountCents:
                        description: 'The same amount in integer cents: amount times 100'
                        type: integer
                      currency:
                        description: ISO 4217 code
                        type: string
                  exposure:
                    description: Money amount
                    type: object
                    required:
                      - amount
                      - amountCents
                      - currency
                    properties:
                      amount:
                        pattern: ^-?\d+\.\d{2}$
                        description: Decimal string, two decimals
                        type: string
                      amountCents:
                        description: 'The same amount in integer cents: amount times 100'
                        type: integer
                      currency:
                        description: ISO 4217 code
                        type: string
                  available:
                    description: Money amount
                    type: object
                    required:
                      - amount
                      - amountCents
                      - currency
                    properties:
                      amount:
                        pattern: ^-?\d+\.\d{2}$
                        description: Decimal string, two decimals
                        type: string
                      amountCents:
                        description: 'The same amount in integer cents: amount times 100'
                        type: integer
                      currency:
                        description: ISO 4217 code
                        type: string
        '401':
          description: Error. `code` is stable; `message` is for humans and may change.
          content:
            application/json:
              schema:
                description: >-
                  Error. `code` is stable; `message` is for humans and may
                  change.
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                    enum:
                      - VALIDATION_FAILED
                      - MODE_REQUIRED
                      - INVALID_STAKE
                      - INVALID_PRICE
                      - INVALID_EXPIRY
                      - CURRENCY_NOT_SUPPORTED
                      - BOOKMAKER_NOT_AVAILABLE_VIA_API
                      - BOOKMAKER_NOT_AVAILABLE
                      - INVALID_API_KEY
                      - API_ACCESS_DENIED
                      - ACCOUNT_NOT_ACTIVE
                      - BETTING_NOT_ALLOWED
                      - BALANCE_UNAVAILABLE
                      - INSUFFICIENT_FUNDS
                      - MAX_STAKE_PER_FIXTURE_EXCEEDED
                      - PRICE_NOT_AVAILABLE
                      - PRICE_CHANGED
                      - NO_LIQUIDITY
                      - INSUFFICIENT_LIQUIDITY
                      - CLIENT_ORDER_ID_REUSED
                      - PREVIOUS_ATTEMPT_UNRESOLVED
                      - NOT_FOUND
                      - INVALID_CURSOR
                      - INVALID_WINDOW
                      - ORDER_BUSY
                      - CONFLICT
                      - FORBIDDEN
                      - RATE_LIMITED
                      - BETTING_SUSPENDED
                      - EXPIRY_NOT_AVAILABLE
                      - PUBLIC_API_DISABLED
                      - SERVICE_UNAVAILABLE
                      - UPSTREAM_UNAVAILABLE
                      - FEED_UNAVAILABLE
                      - FEED_TIMEOUT
                      - INTERNAL_ERROR
                  message:
                    type: string
                  details: {}
        '403':
          description: Error. `code` is stable; `message` is for humans and may change.
          content:
            application/json:
              schema:
                description: >-
                  Error. `code` is stable; `message` is for humans and may
                  change.
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                    enum:
                      - VALIDATION_FAILED
                      - MODE_REQUIRED
                      - INVALID_STAKE
                      - INVALID_PRICE
                      - INVALID_EXPIRY
                      - CURRENCY_NOT_SUPPORTED
                      - BOOKMAKER_NOT_AVAILABLE_VIA_API
                      - BOOKMAKER_NOT_AVAILABLE
                      - INVALID_API_KEY
                      - API_ACCESS_DENIED
                      - ACCOUNT_NOT_ACTIVE
                      - BETTING_NOT_ALLOWED
                      - BALANCE_UNAVAILABLE
                      - INSUFFICIENT_FUNDS
                      - MAX_STAKE_PER_FIXTURE_EXCEEDED
                      - PRICE_NOT_AVAILABLE
                      - PRICE_CHANGED
                      - NO_LIQUIDITY
                      - INSUFFICIENT_LIQUIDITY
                      - CLIENT_ORDER_ID_REUSED
                      - PREVIOUS_ATTEMPT_UNRESOLVED
                      - NOT_FOUND
                      - INVALID_CURSOR
                      - INVALID_WINDOW
                      - ORDER_BUSY
                      - CONFLICT
                      - FORBIDDEN
                      - RATE_LIMITED
                      - BETTING_SUSPENDED
                      - EXPIRY_NOT_AVAILABLE
                      - PUBLIC_API_DISABLED
                      - SERVICE_UNAVAILABLE
                      - UPSTREAM_UNAVAILABLE
                      - FEED_UNAVAILABLE
                      - FEED_TIMEOUT
                      - INTERNAL_ERROR
                  message:
                    type: string
                  details: {}
        '409':
          description: Error. `code` is stable; `message` is for humans and may change.
          content:
            application/json:
              schema:
                description: >-
                  Error. `code` is stable; `message` is for humans and may
                  change.
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                    enum:
                      - VALIDATION_FAILED
                      - MODE_REQUIRED
                      - INVALID_STAKE
                      - INVALID_PRICE
                      - INVALID_EXPIRY
                      - CURRENCY_NOT_SUPPORTED
                      - BOOKMAKER_NOT_AVAILABLE_VIA_API
                      - BOOKMAKER_NOT_AVAILABLE
                      - INVALID_API_KEY
                      - API_ACCESS_DENIED
                      - ACCOUNT_NOT_ACTIVE
                      - BETTING_NOT_ALLOWED
                      - BALANCE_UNAVAILABLE
                      - INSUFFICIENT_FUNDS
                      - MAX_STAKE_PER_FIXTURE_EXCEEDED
                      - PRICE_NOT_AVAILABLE
                      - PRICE_CHANGED
                      - NO_LIQUIDITY
                      - INSUFFICIENT_LIQUIDITY
                      - CLIENT_ORDER_ID_REUSED
                      - PREVIOUS_ATTEMPT_UNRESOLVED
                      - NOT_FOUND
                      - INVALID_CURSOR
                      - INVALID_WINDOW
                      - ORDER_BUSY
                      - CONFLICT
                      - FORBIDDEN
                      - RATE_LIMITED
                      - BETTING_SUSPENDED
                      - EXPIRY_NOT_AVAILABLE
                      - PUBLIC_API_DISABLED
                      - SERVICE_UNAVAILABLE
                      - UPSTREAM_UNAVAILABLE
                      - FEED_UNAVAILABLE
                      - FEED_TIMEOUT
                      - INTERNAL_ERROR
                  message:
                    type: string
                  details: {}
        '429':
          description: Error. `code` is stable; `message` is for humans and may change.
          content:
            application/json:
              schema:
                description: >-
                  Error. `code` is stable; `message` is for humans and may
                  change.
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                    enum:
                      - VALIDATION_FAILED
                      - MODE_REQUIRED
                      - INVALID_STAKE
                      - INVALID_PRICE
                      - INVALID_EXPIRY
                      - CURRENCY_NOT_SUPPORTED
                      - BOOKMAKER_NOT_AVAILABLE_VIA_API
                      - BOOKMAKER_NOT_AVAILABLE
                      - INVALID_API_KEY
                      - API_ACCESS_DENIED
                      - ACCOUNT_NOT_ACTIVE
                      - BETTING_NOT_ALLOWED
                      - BALANCE_UNAVAILABLE
                      - INSUFFICIENT_FUNDS
                      - MAX_STAKE_PER_FIXTURE_EXCEEDED
                      - PRICE_NOT_AVAILABLE
                      - PRICE_CHANGED
                      - NO_LIQUIDITY
                      - INSUFFICIENT_LIQUIDITY
                      - CLIENT_ORDER_ID_REUSED
                      - PREVIOUS_ATTEMPT_UNRESOLVED
                      - NOT_FOUND
                      - INVALID_CURSOR
                      - INVALID_WINDOW
                      - ORDER_BUSY
                      - CONFLICT
                      - FORBIDDEN
                      - RATE_LIMITED
                      - BETTING_SUSPENDED
                      - EXPIRY_NOT_AVAILABLE
                      - PUBLIC_API_DISABLED
                      - SERVICE_UNAVAILABLE
                      - UPSTREAM_UNAVAILABLE
                      - FEED_UNAVAILABLE
                      - FEED_TIMEOUT
                      - INTERNAL_ERROR
                  message:
                    type: string
                  details: {}
        '503':
          description: Error. `code` is stable; `message` is for humans and may change.
          content:
            application/json:
              schema:
                description: >-
                  Error. `code` is stable; `message` is for humans and may
                  change.
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                    enum:
                      - VALIDATION_FAILED
                      - MODE_REQUIRED
                      - INVALID_STAKE
                      - INVALID_PRICE
                      - INVALID_EXPIRY
                      - CURRENCY_NOT_SUPPORTED
                      - BOOKMAKER_NOT_AVAILABLE_VIA_API
                      - BOOKMAKER_NOT_AVAILABLE
                      - INVALID_API_KEY
                      - API_ACCESS_DENIED
                      - ACCOUNT_NOT_ACTIVE
                      - BETTING_NOT_ALLOWED
                      - BALANCE_UNAVAILABLE
                      - INSUFFICIENT_FUNDS
                      - MAX_STAKE_PER_FIXTURE_EXCEEDED
                      - PRICE_NOT_AVAILABLE
                      - PRICE_CHANGED
                      - NO_LIQUIDITY
                      - INSUFFICIENT_LIQUIDITY
                      - CLIENT_ORDER_ID_REUSED
                      - PREVIOUS_ATTEMPT_UNRESOLVED
                      - NOT_FOUND
                      - INVALID_CURSOR
                      - INVALID_WINDOW
                      - ORDER_BUSY
                      - CONFLICT
                      - FORBIDDEN
                      - RATE_LIMITED
                      - BETTING_SUSPENDED
                      - EXPIRY_NOT_AVAILABLE
                      - PUBLIC_API_DISABLED
                      - SERVICE_UNAVAILABLE
                      - UPSTREAM_UNAVAILABLE
                      - FEED_UNAVAILABLE
                      - FEED_TIMEOUT
                      - INTERNAL_ERROR
                  message:
                    type: string
                  details: {}
      security:
        - apiKey: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key

````

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