> ## 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 summary

> Get a summary of a collateral account including positions, margin, and unrealized PnL via the V4 API.

* [Collateral account balance](/api-reference/collateral-trading/collateral-account-balance) — View per-asset collateral balances
* [Collateral account balance summary](/api-reference/collateral-trading/collateral-account-balance-summary) — View detailed per-asset balance breakdown
* [Change collateral account leverage](/api-reference/collateral-trading/change-collateral-account-leverage) — Adjust account leverage
* [Open positions](/api-reference/collateral-trading/open-positions) — List current open positions


## OpenAPI

````yaml /openapi/private/http-trade-v4.yaml POST /api/v4/collateral-account/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/summary:
    post:
      tags:
        - Collateral Trading
      summary: Collateral Account Summary
      description: >
        The endpoint returns a collateral account summary including total
        equity, used margin, free margin, unrealized profit and loss, and the
        current leverage level. The `marginFraction` field indicates the ratio
        of used margin to total equity.


        <Warning>

        Rate limit: 12000 requests/10 sec.

        </Warning>
      operationId: collateralAccountSummary
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                request:
                  type: string
                  example: '{{request}}'
                nonce:
                  type: integer
                  example: 1594297865000
            example:
              request: '{{request}}'
              nonce: 1594297865000
      responses:
        '200':
          description: Successful response - returns collateral account summary
          content:
            application/json:
              schema:
                type: object
                properties:
                  equity:
                    type: string
                    description: Total equity value of the collateral account
                    example: '15000.50'
                  margin:
                    type: string
                    description: Total margin used
                    example: '5000.00'
                  freeMargin:
                    type: string
                    description: Available margin for trading
                    example: '10000.50'
                  unrealizedFunding:
                    type: string
                    description: Unrealized funding payments
                    example: '25.75'
                  pnl:
                    type: string
                    description: Unrealized profit and loss
                    example: '150.25'
                  leverage:
                    type: integer
                    description: Current leverage level
                    example: 3
                  marginFraction:
                    type: string
                    description: Margin fraction ratio (margin / equity)
                    example: '0.3333'
              example:
                equity: '15000.50'
                margin: '5000.00'
                freeMargin: '10000.50'
                unrealizedFunding: '25.75'
                pnl: '150.25'
                leverage: 3
                marginFraction: '0.3333'
        '422':
          description: Request 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)).

````