9. Collect Aggregated Data

Overview

Our service automatically aggregates data for linked accounts overnight on a daily basis. An account must have valid credentials to the financial institution to aggregate. When you retrieve aggregated data from our service, you are getting the data from the most recent successful aggregation.

The methods below describe different ways to retrieve aggregated data. Each method provides a different data scope and response format. The right choice depends on your use case and user type:

• REST API — for retrieving data on demand for an individual investor. Does not currently support advisors.
• DataConnect API — for retrieving a wider scope of data for one or more users in batch. Supports both investors and advisors. Available in XML and CSV formats.

Instructions

1. Collect data for an individual investor (REST API)

To retrieve position and transaction data on demand for an individual investor, use the following REST API endpoints:

• GET /api/v1/positions
  • API Reference
  • Postman example
• GET /api/v1/transactions
  • API Reference
  • Postman example

The REST API does not currently support the advisor use case.

2. Collect batch data in XML format (DataConnect API)

Use the DataConnect Get Data (asynchronous) <DATAGETRQ_A> operation to retrieve a wider scope of data, including personal profile, position, and transaction information, for one or more users in XML format. Use the DataConnect <DATACLAIMRQ> operation to poll for completion and collect the resulting data.

📘

Data scope is determined by credentials

The scope of output data from DataConnect calls is determined by the credentials provided in the operation:

• Advisor or read-write (RW) Assistant credentials return data at advisor scope.
• DataConnect Administrator credentials return data at firm-wide scope, including all advisors at the firm and every investor under them.

For investors:

Step 1: Retrieve XML data — featuring <DATAGETRQ_A>

• Postman example
• The example uses a firm-level data scope and includes tags for user, account, holding, and transaction. Other tags can be used to include additional information.

Step 2: Claim the data — featuring <DATACLAIMRQ>

• Postman example

For advisors:

Step 1: Retrieve XML data — featuring <DATAGETRQ_A>

• Postman example
• Two examples are provided: one retrieves data for the firm, the other for multiple advisors. Use the dropdown in Postman to select the example.

Step 2: Claim the data — featuring <DATACLAIMRQ>

• Postman example

In the examples, <INCTX> is an empty tag, so the operation will retrieve all transactions. You can use an <INCTX> aggregate to limit the transactions returned to a range of transactions by ID, by transaction start date (and optionally end date), or by settlement start date (and optionally settlement end date).

3. Collect batch data in CSV format (DataConnect API)

The DataConnect operations Export Data (asynchronous) <DATAEXPORTRQ_A>, Claim Data <DATACLAIMRQ>, and Claim File <FILECLAIMRQ> retrieve accounts, holdings, and transactions in CSV-delimited format. The CSV files are created using additional business rules to logically organize data. While the CSV export does not include all the fields that the XML data does (retrieved using <DATAGETRQ_A>), such as multicurrency, the files are easier to review and more easily loaded into and consumed by other systems.

The example uses a firm-level data scope:

• Step 1: Export data — featuring <DATAEXPORTRQ_A>
  • Postman example
  • Includes tags to identify fields to include in the export.
• Step 2: Claim the data — featuring <DATACLAIMRQ>
  • Postman example
  • Uses the receipt from <DATAEXPORTRQ_A>.
• Step 3: Claim the file — featuring <FILECLAIMRQ>
  • Postman example
  • Uses the receipt from <DATAEXPORTRQ_A>. The response is a ZIP file containing CSV files and a README.txt.

You can optionally restrict the transactions output to a date range.

📘

Looking for CI SaaS exports?

Custodial Integrator SaaS (CI SaaS) is a licensed add-on with enhanced export capabilities, including prices, securities, and advanced business rules for reconciliation and performance reporting. CI SaaS exports use a separate set of DataConnect operations and are documented in the DataConnect Export Guide for CI SaaS PortfolioCenter and Universal.