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

# Get account equity and risk summary

> Requires `account:read`. Risk-derived fields are grouped under `risk`.



## OpenAPI

````yaml /openapi/portfobit-openapi.yaml get /accounts/{account_id}/summary
openapi: 3.1.0
info:
  title: Portfobit Open API
  version: 0.1.0
  description: >
    Public REST API for direct API clients, CI, scripts, service accounts,
    third-party agents, and developer integrations.

    Public REST requests use scoped Portfobit Open API keys. OAuth access tokens
    issued for the Portfobit MCP resource are not accepted by `/api/v1/*`
    endpoints.

    Portfobit is crypto-CEX-only. Financial values are decimal strings and
    timestamps are RFC 3339 UTC strings.

    The API never supports withdrawals, external-address transfers,
    cross-exchange transfers, or P2P transfers.
servers:
  - url: https://api.portfobit.com/api/v1
security:
  - bearerAuth: []
tags:
  - name: Context
  - name: Accounts
  - name: Portfolios
  - name: Valuation
  - name: Activity
  - name: Trading
  - name: Market data
  - name: Support
paths:
  /accounts/{account_id}/summary:
    get:
      tags:
        - Accounts
      summary: Get account equity and risk summary
      description: Requires `account:read`. Risk-derived fields are grouped under `risk`.
      operationId: getAccountSummary
      parameters:
        - $ref: '#/components/parameters/AccountId'
      responses:
        '200':
          $ref: '#/components/responses/AccountSummaryResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
components:
  parameters:
    AccountId:
      name: account_id
      in: path
      required: true
      schema:
        type: string
      description: Connected CEX account ID.
  responses:
    AccountSummaryResponse:
      description: Account summary response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AccountSummaryResponseSchema'
    ErrorResponse:
      description: Error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  schemas:
    AccountSummaryResponseSchema:
      type: object
      required:
        - data
        - meta
      properties:
        data:
          type: object
          required:
            - account_id
            - venue
            - base_currency
            - equity
            - wallet_balance
            - unrealized_pnl
            - risk
            - as_of
          properties:
            account_id:
              type: string
            venue:
              type: string
            base_currency:
              type: string
            equity:
              type: string
            wallet_balance:
              type: string
            unrealized_pnl:
              type: string
            risk:
              type: object
              required:
                - status
                - level
                - model_version
                - as_of
                - reasons
                - metrics
              properties:
                status:
                  type: string
                level:
                  type: string
                model_version:
                  type: string
                as_of:
                  type: string
                  format: date-time
                reasons:
                  type: array
                  items:
                    type: object
                metrics:
                  type: object
                  required:
                    - gross_exposure
                    - net_exposure
                    - margin_utilization
                    - gross_leverage
                  properties:
                    gross_exposure:
                      type: string
                    net_exposure:
                      type: string
                    margin_utilization:
                      type: string
                    gross_leverage:
                      type: string
            as_of:
              type: string
              format: date-time
        meta:
          type: object
          required:
            - request_id
            - generated_at
          properties:
            request_id:
              type: string
            generated_at:
              type: string
              format: date-time
      example:
        data:
          account_id: acc_01H8XFK9A
          venue: binance
          base_currency: USD
          equity: '1000.00'
          wallet_balance: '1000.00'
          unrealized_pnl: '25.00'
          risk:
            status: available
            level: low
            model_version: risk_v1
            as_of: '2026-08-07T08:00:00Z'
            reasons: []
            metrics:
              gross_exposure: '1200.00'
              net_exposure: '1000.00'
              margin_utilization: '0.10'
              gross_leverage: '1.20'
          as_of: '2026-08-07T08:00:00Z'
        meta:
          request_id: req_01J2K8B7QW
          generated_at: '2026-08-07T08:00:01Z'
    ErrorEnvelope:
      type: object
      required:
        - error
        - meta
      properties:
        error:
          $ref: '#/components/schemas/Error'
        meta:
          $ref: '#/components/schemas/Meta'
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
        message:
          type: string
        details:
          type: object
          additionalProperties: true
    Meta:
      type: object
      required:
        - request_id
        - generated_at
      properties:
        request_id:
          type: string
        generated_at:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Portfobit Open API key

````

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