Introduction

The Addepar API Explorer is the complete interactive reference for the V1 REST API. Every endpoint listed here is available to your firm — select an endpoint, fill in parameters, and execute live requests directly from this page.

Quick Start

Step	Action
1	Get your API key from Settings > API Keys in the Addepar platform
2	Choose your environment from the server dropdown above any endpoint
3	Enter your `Addepar-Firm` header value (your firm ID)
4	Click Try It to execute the request

Environments

Environment	Base URL	Use Case
Production	`https://{firm}.addepar.com/api/v1`	Live client data
Development	`https://{firm}.clientdev.addepar.com/api/v1`	Testing & integration work
Premier Sandbox	`https://{firm}.sandbox.addepar.com/api/v1`	Isolated test environment

Replace {firm} with your firm's subdomain.

Authentication

All requests require two things:

API Key — passed as a Bearer token in the Authorization header
Addepar-Firm — your firm identifier, passed as a request header on every call

curl -X GET "https://examplefirm.addepar.com/api/v1/entities" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Addepar-Firm: YOUR_FIRM_ID" \
  -H "Accept: application/vnd.api+json"

For full details, see Access & Authentication.

Request & Response Format

The Addepar API follows the JSON:API specification:

Content-Type: application/vnd.api+json
Resources are wrapped in a data object with type, id, and attributes
Relationships are expressed via relationships and linkage objects
Pagination uses cursor-based page[cursor] and page[limit] query parameters

What's Covered

This reference covers 384 endpoints across 48 resource areas:

Domain	Resources
Ownership	Entities, Entity Types, Groups, Group Types, Positions, External ID Types
People & Access	Users, Roles, Teams, Contacts, Personas
Financials	Transactions, Transaction Jobs, Jobs, Portfolio, Snapshots
Attributes	Attributes, Arguments, Constituent Attributes
Benchmarks	Benchmarks, Associations, Compositions, Proxies, Imported Data
Pricing	Pricing Sources, Pricing Datasets, Estimated Returns, Derivatives
Billing	Billable Portfolios, Fee Schedules, Fees, Payout Recipients & Rules
Allocations	Allocation Models, Allocation Templates
Reporting	Generated Reports, Report Generation, Report Schedule, Reports
Data Management	Files, Archived Files, Imports, Import Results, Data Timelines, Transaction Datasets
Admin	Audit Trail, View Sets, Portal, API Version

Guides & Resources

Getting Started — Platform overview and first steps
Resource Overview — How Addepar models data
Pagination — Cursor-based pagination patterns
Rate Limiting — Request limits and best practices
Response Codes — Error handling reference
OAuth — OAuth 2.0 integration guide