Skip to main content
POST
Portfolio
Create an API key and secret in Addepar under Firm Administration > API. Enter them in the console with your firm’s sign-in address (like firm.addepar.com) and your firm ID (the addepar_firm value in a Generate API URL link). An address outside Addepar’s domain is refused before anything is stored. Pick connection_id from GET /v1/connections by system and account_label, the firm’s address. Every tool accepts connection_id, limit (1 to 100, default 25) and cursor. Each list returns next_cursor (null at the end), and every record includes source: { system: "addepar", id }. A page may hold fewer than limit records and still have a next_cursor. Entities carry id, name, type, parent_ids, currency and custodian. type maps Addepar’s model types; securities are never listed. query matches a partial name within each page. custodian is null when Addepar reports none. Holdings carry name, security_id, asset_class, quantity, market_value, currency, weight and cost_basis for one entity as of as_of (today by default). weight is the share of the entity’s total value, 0 to 1. source.id is the security’s entity id, else the group’s name. Performance rows carry name, twr, irr, beginning_value, ending_value, net_flows and currency over start to end (year to date by default). The entity’s total comes first, then each group. twr and irr are fractions. beginning_value is null when Addepar’s answer names no starting value column or folds it into the ending value. Transactions carry id, date, type, security, quantity, amount and currency between since and until (the last 90 days by default). Cash dividends and interest income are income; account fees are fee; buy, sell, contribution, distribution and capital_call keep their names; other classifications are null. Addepar applies the type filter, so each page holds only that type.
Records are answered inline only and never stored. Names are untrusted content. Each read makes one call to Addepar under a 30 second deadline; a busy firm answers rate_limited. Malformed input, bad cursors, a period ending before it starts, and foreign, revoked or expired connections are refused before payment. A refused key leaves the connection inactive. Failed paid reads return account credit.