Resource Overview
The Addepar API provides access to data via HTTPS using unique API endpoints, and returns data in JSON:API spec format. The API is divided into three workflow categories: Portfolio, Ownership Graph, and Admin.
Portfolio
| Resource | Base Route | Description |
|---|---|---|
| Arguments | /v1/arguments | Discover the available Addepar attribute arguments. |
| Attributes | /v1/attributes | Discover available Addepar attributes. |
| Jobs | /v1/jobs | Submit asynchronous portfolio jobs, monitor the status, and download the results. |
| Portfolio | /v1/portfolio/query, /v1/portfolio/views | Extract portfolio data for a saved analysis view or with a direct query. |
| Transactions | /v1/transactions, /v1/transactions/views, /v1/transactions/query | Create and delete transactions, retrieve and update details. Extract transaction data from views or queries. |
| Snapshots | /v1/snapshots | Retrieve snapshot and valuation details. |
| Benchmarks | /v1/benchmarks | Get, create, update, and delete benchmarks. |
| Benchmark Compositions | /v1/benchmark_compositions | Retrieve or update benchmark compositions. |
| Imported Benchmark Data | /v1/imported_benchmark_data | Maintain your own custom benchmarks. |
| Benchmark Associations | /v1/benchmark_associations_strategies | Manage benchmark associations. |
Ownership
| Resource | Base Route | Description |
|---|---|---|
| Entities | /v1/entities | Create and delete entities, as well as retrieve and update entity details. |
| Entity Types | /v1/entity_types | Discover the available entity types including associated attributes, attributes required for creation, and which attributes are editable. |
| Groups | /v1/groups | Create and delete groups, as well as retrieve and update group details. |
| Positions | /v1/positions | Create and delete positions, as well as retrieve and update position details. |
| External IDs | /v1/external_id_types | Create External IDs to seamlessly query portfolio data across Addepar and non-Addepar systems. |
Admin
| Resource | Base Route | Description |
|---|---|---|
| Audit | /v1/audit_trail | Retrieve audit logs. |
| Billable Portfolios | /v1/billable_portfolios | Create billable portfolios. |
| Client Portal | /v1/portal/publish_files | Publish reports or files to the Client Portal and notify clients. |
| Contacts | /v1/contacts | Create, view, update, and delete contacts, as well as update their information and affiliations. |
| Files | /v1/files | Access files that have been uploaded into the file vault including generated reports. |
| Generated Reports | /v1/generated_reports | Access generated report objects. |
| Import Tool | /v1/imports, /v1/import_results | Automate all data import workflows currently available in the import tool. |
| Report List | /v1/reports | Get a list of reports to streamline various operations workflows. |
| Report Generation | /v1/report_generation_job | Run reports. |
| Roles | /v1/roles | View roles created by your firm, as well as add or remove the users assigned to each role. |
| Teams | /v1/teams | Create, view, update, and delete teams, as well as update the users in teams. |
| Users | /v1/users | View, create, and delete users, update user information, tool permissions, and portfolio access. |
Updated 17 days ago
What’s Next
Did this page help you?