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

# Collateral account balance summary

> Get a summary of collateral account balances including equity and margin usage via the V4 API.

export const RelatedResources = ({children}) => {
  const ref = useRef(null);
  const [visible, setVisible] = useState(false);
  useEffect(() => {
    if (!ref.current) return;
    const el = ref.current;
    if (el.parentElement) {
      el.parentElement.appendChild(el);
    }
    setVisible(true);
  }, []);
  return <div ref={ref} className="related-resources" style={{
    marginTop: "2.5rem",
    paddingTop: "1.5rem",
    borderTop: "1px solid var(--border-color, #e5e7eb)",
    opacity: visible ? 1 : 0,
    transition: "opacity 0.15s ease-in"
  }}>
      <h2 style={{
    marginTop: 0
  }}>Related resources</h2>
      {children}
    </div>;
};

<RelatedResources>
  * [Collateral account balance](/api-reference/collateral-trading/collateral-account-balance) — View per-asset collateral balances
  * [Collateral account summary](/api-reference/collateral-trading/collateral-account-summary) — View account-level margin and equity
  * [Open positions](/api-reference/collateral-trading/open-positions) — List current open positions
  * [Change collateral account leverage](/api-reference/collateral-trading/change-collateral-account-leverage) — Adjust account leverage
</RelatedResources>


## OpenAPI

````yaml /openapi/private/http-trade-v4.yaml POST /api/v4/collateral-account/balance-summary
openapi: 3.0.3
info:
  title: Private HTTP API V4 - Collateral Trading
  description: |
    WhiteBIT Private HTTP API V4 for collateral/margin trading operations.

    Base URL: https://whitebit.com

    All endpoints return time in Unix-time format.
    All endpoints return either a JSON object or array.
    For receiving responses from API calls please use http method POST.

    Authentication required for all endpoints.
  version: 4.0.0
  license:
    name: WhiteBIT Terms of Service
    url: https://whitebit.com/terms
servers:
  - url: https://whitebit.com
    description: WhiteBIT Global Server
  - url: https://whitebit.eu
    description: WhiteBIT EU Server
security:
  - ApiKeyAuth: []
    PayloadAuth: []
    SignatureAuth: []
tags:
  - name: Collateral Trading
    description: Endpoints for collateral/margin trading operations
  - name: Spot Trading
    description: Endpoints for spot trading operations
  - name: Market Fee
    description: Endpoints for querying trading fees
paths:
  /api/v4/collateral-account/balance-summary:
    post:
      tags:
        - Collateral Trading
      summary: Collateral Account Balance Summary
      description: >
        The endpoint returns a detailed [collateral
        balance](/glossary#balance-collateral) summary with a per-asset
        breakdown. Each record includes the current balance, borrowed amount,
        and available balance with and without borrowing capacity. Use the
        optional `ticker` parameter to filter results to a single asset.


        <Note>

        The API does not cache the response.

        </Note>


        <Warning>

        Rate limit: 12000 requests/10 sec.

        </Warning>


        <Accordion title="Errors">

        ```json

        {
          "code": 30,
          "message": "Validation failed",
          "errors": {
            "ticker": ["ticker is invalid."]
          }
        }

        ```

        </Accordion>
      operationId: collateralAccountBalanceSummary
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ticker:
                  type: string
                  description: |
                    Filter by requested asset. For example: BTC

                    If not specified, returns summary for all assets.
                  example: BTC
                request:
                  type: string
                  description: Request signature
                  example: '{{request}}'
                nonce:
                  type: string
                  description: Unique request identifier
                  example: '{{nonce}}'
            example:
              ticker: BTC
              request: '{{request}}'
              nonce: '{{nonce}}'
      responses:
        '200':
          description: Successful response - returns detailed balance information per asset
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    asset:
                      type: string
                      description: Asset ticker symbol
                      example: BTC
                    balance:
                      type: string
                      description: >-
                        Total collateral balance for the asset, in the asset's
                        native units
                      example: '0.5'
                    borrow:
                      type: string
                      description: >-
                        Amount currently borrowed against the asset, in the
                        asset's native units
                      example: '0'
                    availableWithoutBorrow:
                      type: string
                      description: >-
                        Balance available for use without additional borrowing,
                        in the asset's native units
                      example: '0.5'
                    availableWithBorrow:
                      type: string
                      description: >-
                        Maximum balance available when borrowing capacity is
                        included, in the asset's native units
                      example: '123.456'
              example:
                - asset: BTC
                  balance: '0.5'
                  borrow: '0'
                  availableWithoutBorrow: '0.5'
                  availableWithBorrow: '123.456'
                - asset: USDT
                  balance: '1000'
                  borrow: '0'
                  availableWithoutBorrow: '1000'
                  availableWithBorrow: '5000'
        '422':
          description: Inner validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Service temporarily unavailable
      security:
        - ApiKeyAuth: []
          PayloadAuth: []
          SignatureAuth: []
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
          description: Error code
          example: 30
        message:
          type: string
          description: Error message
          example: Validation failed
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Detailed error information
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-TXC-APIKEY
      description: The public WhiteBIT API key.
    PayloadAuth:
      type: apiKey
      in: header
      name: X-TXC-PAYLOAD
      description: Base64-encoded JSON request body.
    SignatureAuth:
      type: apiKey
      in: header
      name: X-TXC-SIGNATURE
      description: >-
        HMAC-SHA512 signature of the payload, hex-encoded. Computed as
        hex(HMAC-SHA512(payload, api_secret)).

````