Routes and Organization
Organization of endpoints into sections of the Wealthtech API
The Wealthtech API is organized into the following sections, each has a set of endpoints to interact with resources:
- Account management:
/v2/account-management
- Billing:
/v2/billing
- Reporting:
/v2/reporting
- Core data
- Normalized, ledgerized financial institution data:
/v2/data/luca
- Security reference data obtained from custodians:
/v2/data/custodian/securities
- Normalized, ledgerized financial institution data:
- User management:
/v2/user-management
- File sharing:
/v2/file-sharing
- Background Jobs:
/v2/jobs
- Analytics:
/v2/analytics
- Firms:
/v2/org
- Auth resources (API keys):
/v2/auth
Each section of the application has a set of endpoints corresponding to resources. Each resource has an object type to make it easy to distinguish json data.
Endpoints and object types
API section | Endpoint | Object type(s) |
---|---|---|
Account management/v2/account-management | /accounts | account_management.account |
/households | account_management.household | |
/heldaways | account_management.heldaway | |
Billing/v2/billing | /asset-adjustments | billing.asset_adjustment |
/fee-structures | billing.fee_structure | |
/groups | billing.group | |
/invoices | billing.invoice | |
/minimums | billing.minimum | |
/reports | billing.report | |
/splits | billing.split | |
/fee-upload-files | billing.fee_upload_file | |
Custodian portfolio data/v2/data/luca | /buy-sells | data.luca.buy_sell |
/income-expense | data.luca.income_expense | |
/transfers | data.luca.transfer | |
/account-balances | data.luca.account_balance | |
/household-balances | data.luca.household_balance | |
/account-historical-balances | data.luca.account_historical_balance | |
/household-historical-balances | data.luca.household_historical_balance | |
/account-security-balances | data.luca.account_security_balance | |
/household-security-balances | data.luca.household_security_balance | |
/account-holdings | data.luca.account_holding | |
/household-holdings | data.luca.household_holding | |
/positions | data.luca.position | |
/gain-loss | data.luca.gain_loss | |
User management/v2/user-management | /roles | user_management.role |
/firm-profiles | user_management.firm_profile | |
/client-profiles | user_management.client_profile | |
Analytics/v2/analytics | /aum | analytics.aum |
Firms and organizations/v2/org | /firms | org.firm |
Background jobs/jobs | / | job.background_job |
Custodian security data/v2/data/security | / | data.custodian.security |
Reporting/v2/reporting | /benchmarks | reporting.benchmark reporting.benchmark_coefficient |
/asset-adjustments | billing.asset_adjustment | |
/class-tags | reporting.class_tag | |
/printable-reports | reporting.printable | |
/report-settings | reporting.setting | |
API keys/v2/auth | /api-keys | auth.apikey |
Updated 4 months ago