---
title: "Portfolios"
method: GET
path: "/v1/portfolios"
tags: ["portfolios"]
---

# Portfolios

`GET /v1/portfolios`

## Request

- Base URL: `https://api.rayana.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.rayana.ai/v1/portfolios`
- Auth: none declared

The full shelf of model portfolios as merchandising cards, served to every
tier (it is the funnel). Draft books are never shown; ``?include_retired=true``
also returns archived books whose track record is frozen.

Each card carries ``openable`` (whether *this* caller's tier can open the
book) and ``delayed`` (whether this caller would see it on a delay), so a
client can render the whole shelf with lock/delay badges.

## Query parameters

- `include_retired` boolean

## Headers

- `X-API-Key` string, nullable

## Response `200`

Successful Response

- PortfolioShelf
  - `count` integer, required
  - `tier` string, required
  - `portfolios` ShelfCard[], required
    - `slug` string, required
    - `display_name` string, nullable
    - `objective` string, nullable
    - `risk_tier` string, nullable
    - `mechanism_blurb` string, nullable
    - `asset_class` string, nullable
    - `benchmark` string, nullable
    - `tier` string, nullable
    - `status` string, nullable
    - `inception_date` string, nullable
    - `last_update` string, nullable
    - `n_holdings` integer, nullable
    - `nav` number, nullable
    - `cum_return_pct` number, nullable
    - `cagr_pct` number, nullable
    - `drawdown_pct` number, nullable
    - `openable` boolean, nullable
    - `delayed` boolean, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/rayana/apis/orca-api.md) · [All operations](https://skmtc.dev/rayana/apis/orca-api/llms.txt) · [OpenAPI document](https://skmtc.dev/rayana/apis/orca-api/revisions/ef0e2be9d10a?raw)
