Portfolio

The Portfolio API extracts data for a specific portfolio based on a saved analysis view in Addepar or a direct query.

Overview


Base route	`/v1/portfolio`
Produces	JSON, CSV (views only), TSV (views only), XLSX (views only)
Pagination	No
OAuth scopes	`PORTFOLIO`

🔒 Access requirements

API Access: Create, edit, and delete.
Analysis Views: "View only" permission is required to extract view data.

ℹ️ Performance tip

For large-scale data queries, use the Jobs API in conjunction with the Portfolio API. Because Portfolio API retrieves data for entire portfolios, responses can be large and may time out. The Jobs API lets you make asynchronous requests, check status, and download results.

Comparing View vs. Query APIs

	View API	Query API
Use cases	Export a static portfolio view for offline analysis or data warehouse.	Dynamic access to portfolio data. Portable requests across firms.
Request structure	Relies on a saved view in the application.	Query constructed dynamically in the API request.
Portability	Views must be created for each firm.	Requests can be reused across multiple firms.
Batching	Cannot batch requests.	Batches multiple entities in one request.
Attribute coverage	All attributes.	Most attributes.
Supported formats	JSON, CSV, TSV, XLSX	JSON only
Asynchronous	Supported via Jobs API.	Supported via Jobs API.

Get a list of portfolio views

Retrieves a complete list of views for portfolios you have access to.

GET /v1/portfolio/views

🔑 Authentication

All requests require a base64-encoded API key pair:
Authorization: Basic {base64(key_id:key_secret)}
See Access & Authentication for setup.

curl -X GET "https://{firm}.addepar.com/api/v1/portfolio/views" \
  -H "Authorization: Basic {credentials}" \
  -H "Addepar-Firm: 1" \
  -H "Accept: application/vnd.api+json"

{
  "data": [
    {
      "id": "19",
      "type": "portfolio_views",
      "attributes": {
        "display_name": "AdvancedTable",
        "share_type": "PERSONAL"
      },
      "links": {
        "self": "/v1/portfolio_views/19"
      }
    },
    {
      "id": "2",
      "type": "portfolio_views",
      "attributes": {
        "display_name": "owner1",
        "share_type": "FIRM"
      },
      "links": {
        "self": "/v1/portfolio_views/2"
      }
    }
  ],
  "included": [],
  "links": {
    "next": null
  }
}

{
  "errors": [
    {
      "id": "not_found",
      "status": "404",
      "title": "Not Found",
      "detail": "Portfolio view feature is not enabled for this firm."
    }
  ]
}

Response codes:

200 OK -- Success
404 Not Found -- Missing portfolio view feature flag

📘 Related resources

Portfolio Query -- Build dynamic portfolio data queries.

Portfolio Views -- Get view details and results.

Jobs -- Async requests for large portfolio exports.

Overview

Comparing View vs. Query APIs

Get a list of portfolio views

What’s Next