Documentation Index
Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
Use this file to discover all available pages before exploring further.
🚀 Quickstart
🧑💻 OAuth app setup
🔗 Useful links
🚨 API gotchas
Create an integration
In Nango (free signup), go to Integrations -> Configure New Integration -> Addepar. Nango doesn’t provide a test OAuth app for Addepar yet. You’ll need to set up your own by following these instructions. After that, make sure to add the OAuth client ID, secret, and scopes in the integration settings in Nango. Authorize Addepar
Go to Connections -> Add Test Connection -> Authorize, then log in to Addepar. Later, you’ll let your users do the same directly from your app. Call the Addepar API
Let’s make your first request to the Addepar API (fetch a list of all entities). Replace the placeholders below with your secret key, integration ID, and connection ID:curl -X GET "https://api.nango.dev/v1/entities" \
-H "Authorization: Bearer <NANGO-SECRET-KEY>" \
-H "Provider-Config-Key: <INTEGRATION-ID>" \
-H "Connection-Id: <CONNECTION-ID>" \
Install Nango’s backend SDK with npm i @nangohq/node. Then run:import { Nango } from '@nangohq/node';
const nango = new Nango({ secretKey: '<NANGO-SECRET-KEY>' });
// Lists all entities.
const res = await nango.get({
// https://developers.addepar.com/docs/entities#get-all-entities
endpoint: '/v1/entities',
providerConfigKey: '<INTEGRATION-ID>',
connectionId: '<CONNECTION-ID>',
});
console.log(res.data);
Setup your OAuth client
To set up your OAuth client, reach out to your Addepar contact for assistance.
Common Scopes
| Scope | Description |
|---|
PROFILE | Read-only access to your name, email, unique user ID, and Addepar firm ID (used to identify your account) |
PORTFOLIO | Read-only access to client portfolio data including name, quantity, and value of clients, legal entities, accounts, and securities |
TRANSACTIONS or TRANSACTIONS_WRITE | Read or read/write access to client transactions data (e.g., transaction type, owner, and value) |
FILES or FILES_WRITE | Read or read/write access to files and their contents associated with each client |
GROUPS or GROUPS_WRITE | Read or read/write access to group details and attributes such as name, date created, and memberships |
USERS or USERS_WRITE | Read or read/write access to user details (name, email, roles) including contacts and affiliations |
TEAMS or TEAMS_WRITE | Read or read/write access to team details and team memberships |
