9. Collect Aggregated Data

Overview

You can collect aggregated data for an investor using our REST API. You can collect batch aggregated data for multiple investors using our DataConnect API.

📘

Daily Overnight Aggregation

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.

Instructions

Collecting Aggregated Data for an Investor

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

• GET /api/v1/positions
• GET /api/v1/transactions

Collecting Aggregated Data for Multiple Investors (Batch)

Optionally you may use the DataConnect API to collect data for multiple investors for batch processing as it retrieves a wider scope of data than the REST API endpoints, including personal profile, position, and transaction information.

The DataConnect operations to retrieve data for all investors are included in a Postman collection:

• Step 1 featuring <DATAGETRQ_A>. This example uses a firm-level data scope, not an individual investor. It includes tags for user, account, holding, and transaction. Other tags can be used to include additional information.
• Step 2 featuring <DATACLAIMRQ>. This operation polls for completion and collects the resulting data.

Note: For DataConnect operations in Postman, use “Send and Download” then save the response as a .zip file. The response XML is inside that .zip file.

For more about these operations, refer to the DataConnect V4 Ultra User Guide. For details about <DATAGETRQ_A> refer to the “Get Data (Asynchronous)” section. For details about <DATACLAIMRQ>, refer to the “Asynchronous Helper Operations” section.