Routes and Organization

Organization of endpoints into sections of the API

The 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
  • 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 sectionEndpointObject type(s)
Account management
/v2/account-management
/accountsaccount_management.account
/householdsaccount_management.household
/heldawaysaccount_management.heldaway
Billing
/v2/billing
/asset-adjustmentsbilling.asset_adjustment
/fee-structuresbilling.fee_structure
/groupsbilling.group
/invoicesbilling.invoice
/minimumsbilling.minimum
/reportsbilling.report
/splitsbilling.split
/fee-upload-filesbilling.fee_upload_file
Custodian portfolio data
/v2/data/luca
/buy-sellsdata.luca.buy_sell
/income-expensedata.luca.income_expense
/transfersdata.luca.transfer
/account-balancesdata.luca.account_balance
/household-balancesdata.luca.household_balance
/account-historical-balancesdata.luca.account_historical_balance
/household-historical-balancesdata.luca.household_historical_balance
/account-security-balancesdata.luca.account_security_balance
/household-security-balancesdata.luca.household_security_balance
/account-holdingsdata.luca.account_holding
/household-holdingsdata.luca.household_holding
/positionsdata.luca.position
/gain-lossdata.luca.gain_loss
User management
/v2/user-management
/rolesuser_management.role
/firm-profilesuser_management.firm_profile
/client-profilesuser_management.client_profile
Analytics
/v2/analytics
/aumanalytics.aum
Firms and organizations
/v2/org
/firmsorg.firm
Background jobs
/jobs
/job.background_job
Custodian security data
/v2/data/security
/data.custodian.security
Reporting
/v2/reporting
/benchmarksreporting.benchmark
reporting.benchmark_coefficient
/asset-adjustmentsbilling.asset_adjustment
/class-tagsreporting.class_tag
/printable-reportsreporting.printable
/report-settingsreporting.setting
API keys
/v2/auth
/api-keysauth.apikey