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

# Get portfolio summary

> Get authoritative portfolio summary and activity for one rolling period.



## OpenAPI

````yaml /proto-openapi/api/openapi.yaml get /api/v1/accounts/me/portfolio/summary
openapi: 3.0.3
info:
  title: Monaco Protocol API
  description: REST API for the Monaco Protocol hybrid CLOB exchange.
  version: 1.0.0
servers:
  - url: https://staging.apimonaco.xyz
    description: Staging server (Testnet)
security: []
tags:
  - name: AccountsService
  - name: ApplicationsService
  - name: AuthService
  - name: BuildercodeRewardsService
  - name: CopyTradingService
  - name: DelegatedAgentsService
  - name: FaucetService
  - name: FeesService
  - name: HealthService
  - name: ManagedMarketsService
    description: |-
      Wallet-authenticated maker assignments. The signed session must match both
       configured maker user and application. Owner IDs are process fences, never auth.
       Only wallet sessions are supported; delegated-agent sessions receive 403.
  - name: MarginAccountsService
    description: |-
      Current public isolated-margin semantics:
       - a user has one parent margin account per application scope
       - opening orders create or reuse isolated position buckets under that parent
       - parent account creation is handled internally by margin workflows
  - name: MarketService
  - name: OrderbookService
  - name: OrdersService
  - name: PositionsService
    description: |-
      Current public isolated-margin semantics:
       - positions link to a parent margin account and, when applicable, a bucket id
       - opening orders create or reuse isolated position buckets under the parent
       - users can open another isolated position by reusing the parent account with a different market bucket
  - name: PulseService
  - name: SweeperService
  - name: TraderCodeService
  - name: TradesService
  - name: WhitelistService
  - name: WithdrawalsService
paths:
  /api/v1/accounts/me/portfolio/summary:
    get:
      tags:
        - AccountsService
        - Accounts
      summary: Get portfolio summary
      description: Get authoritative portfolio summary and activity for one rolling period.
      operationId: get_portfolio_summary
      parameters:
        - name: period
          in: query
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPortfolioSummaryResponse'
        '400':
          description: Invalid period parameter
        '401':
          description: Authentication required
        '429':
          description: >-
            Read rate limit exceeded — every authenticated read draws one
            request from the account's read budget; retry after the interval in
            details.retryAfter
        '500':
          description: Internal server error
        '503':
          description: Portfolio data unavailable
      security:
        - monacoSignature: []
        - monacoHttpSignature: []
components:
  schemas:
    GetPortfolioSummaryResponse:
      type: object
      properties:
        window:
          $ref: '#/components/schemas/PortfolioWindow'
        valuationStatus:
          enum:
            - complete
            - partial
          type: string
          nullable: true
        current:
          $ref: '#/components/schemas/PortfolioSummaryCurrent'
        activity:
          $ref: '#/components/schemas/PortfolioSummaryActivity'
    PortfolioWindow:
      type: object
      properties:
        period:
          enum:
            - 1d
            - 1w
            - 1m
            - all
          type: string
          description: Closed portfolio period token
          nullable: true
        asOf:
          type: string
          description: Exclusive response query cutoff (RFC3339)
          nullable: true
        dataThrough:
          type: string
          description: Newest underlying observation used (RFC3339)
          nullable: true
        requestedStartsAt:
          type: string
          description: Requested rolling-window start; null for all (RFC3339)
          nullable: true
        effectiveStartsAt:
          type: string
          description: >-
            Actual calculation start after retained-history constraints
            (RFC3339)
          nullable: true
        historyStartsAt:
          type: string
          description: First observation with complete endpoint semantics (RFC3339)
          nullable: true
        coverage:
          enum:
            - complete
            - partial
            - none
          type: string
          description: History coverage for the requested period
          nullable: true
    PortfolioSummaryCurrent:
      type: object
      properties:
        totalEquity:
          type: string
          nullable: true
        spotEquity:
          type: string
          nullable: true
        perpsEquity:
          type: string
          nullable: true
        unrealizedPnl:
          type: string
          nullable: true
        availableValue:
          type: string
          nullable: true
    PortfolioSummaryActivity:
      type: object
      properties:
        volume:
          type: string
          nullable: true
        tradeCount:
          type: string
          nullable: true
        orderCount:
          type: string
          nullable: true
        feesPaid:
          type: string
          nullable: true
  securitySchemes:
    monacoSignature:
      type: apiKey
      description: >-
        Ed25519 session-key request signing. Every authenticated request carries
        three headers: `X-Monaco-PublicKey` (64-char lowercase-hex session
        public key), `X-Monaco-Timestamp` (Unix milliseconds, within 30s of
        server time), and `X-Monaco-Signature` (hex ed25519 signature). The
        signature is over `METHOD\npath?query\ntimestamp_ms\nSHA256_hex(body)`,
        where the body hash is the SHA-256 of the empty byte string when there
        is no body. Obtain the session keypair from `POST
        /api/v1/auth/challenge` followed by `POST /api/v1/auth/verify`.
      name: X-Monaco-Signature
      in: header
    monacoHttpSignature:
      type: apiKey
      description: >-
        RFC 9421 Ed25519 session-key request signatures. Send Signature-Input,
        Signature, and Content-Digest together; never combine them with
        X-Monaco-* credentials. The monaco signature covers @method, @path,
        @query, and content-digest in that order, with created (Unix seconds
        within 30s of server time), keyid (registered lowercase-hex session
        public key), and alg=ed25519 parameters. Content-Digest uses RFC 9530
        sha-256 over the exact body bytes, including the empty body. Query
        coverage retains ordering and percent encoding. Timestamp freshness does
        not reject repeated identical requests; use endpoint idempotency where
        supported. Existing legacy signing remains supported during server-first
        migration; SDK RFC 9421 signing is opt-in. See
        https://docs.0xmonaco.com/reference/http-message-signatures for the
        complete profile and trust model.
      name: Signature
      in: header

````

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