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

# Get portfolio overview

> Read account-level portfolio summary data.

Use this endpoint to show an account summary across running blueprints, open positions, pending orders, and aggregate PnL.

```bash theme={null}
curl https://api.useblueprints.ai/api/portfolio \
  -H "Authorization: Bearer bp_YOUR_API_KEY"
```


## OpenAPI

````yaml /openapi.yaml GET /api/portfolio
openapi: 3.1.0
info:
  title: Blueprints API
  version: '1.0'
  description: >-
    API for approved Blueprints product clients and integrations. Account
    resources require bearer authentication.
servers:
  - url: https://api.useblueprints.ai
security:
  - apiKeyBearer: []
tags:
  - name: Health
    description: Service status endpoints that do not require authentication.
  - name: Market data
    description: Authenticated read-only helpers for finding supported market inputs.
  - name: Blueprints
    description: Create, inspect, update, deploy, and stop account-owned blueprints.
  - name: Orders
    description: Read account order activity.
  - name: Portfolio
    description: Read account-level balances, positions, and portfolio summary data.
  - name: Risk rules
    description: Read and update account-level trading safeguards.
  - name: API keys
    description: Manage API keys used by trusted external integrations and MCP clients.
paths:
  /api/portfolio:
    get:
      tags:
        - Portfolio
      summary: Get portfolio overview
      description: >-
        Returns account-level portfolio summary data such as running blueprints,
        open positions, pending orders, and aggregate PnL. API keys need the
        `portfolio:read` scope.
      operationId: getPortfolioOverview
      responses:
        '200':
          description: Portfolio overview.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Portfolio'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    Portfolio:
      type: object
      properties:
        runningBlueprints:
          type: number
        openPositions:
          type: number
        pendingOrders:
          type: number
        totalPnl:
          type: number
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
        message:
          type: string
  responses:
    Unauthorized:
      description: Missing, invalid, revoked, or expired credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Credential is valid but cannot perform this action.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKeyBearer:
      type: http
      scheme: bearer
      bearerFormat: bp_ API key
      x-default: bp_YOUR_API_KEY

````