When the Altruist software partners initiate the file transfer from Altruist, they are provided files starting on the next business day via data feed endpoints. For applications that need historical data, Altruist provides a historical data feed endpoint retrieving historical data files. Users can retrieve the historical data since the inception of a rep code to view the entire financial history for a group of accounts.

Preparatory Steps

1. Request access to Data Feed API

If you would like to use the historical data feed API, contact softwarepartnerships@altruist.com to get your SFTP set up. Without this configuration, you will not be able to retrieve the data files.

2. File Transfer Process for Retrieving Data Files

To retrieve data files for a specific user, the user must first go through our authentication flow to grant access to our historical data feed API. After making the API requests to the designated endpoints, the historical data feed will start delivering to the SFTP server that we have configured for you.

3. Associating Data Feeds with Rep Codes

In Altruist, data feeds are associated with rep codes, enabling users to selectively export specific datasets. As part of the integration process, it is important to incorporate functionality that allows users to choose and associate the relevant rep codes with their desired data feeds. This can be achieved by leveraging the available APIs and following the data feed management guidelines provided.

4. Accessing Files via Configured SFTP

To seamlessly retrieve files, you will need to pull data files from the configured SFTP (Secure File Transfer Protocol) server. The SFTP setup involves retrieving files from an SFTP server on Altruist. It is crucial to adhere to the specified authentication and encryption protocols to ensure secure and reliable file transfers.

historical-data

To trigger a one-time historical data feed, an HTTP POST request must be sent. The endpoint requires a partner code and a request body containing all necessary information to enable the historical data feed for the current user. Upon successful processing, the API will provide comprehensive details regarding the historical data feed.
We allow for one historical data feed per day (for a given set of repcodes)

Request Headers


`Authorization` required	The access token.

Request Parameters


`partner_code` string, required	The unique partner code.

Request Body Object


`repcodes` array, required	List of `repcodes` to include in the historical data.

Response Object Fields


`id` string	A unique identifier for the historical data feed.
`data_feed_status` string	The status of the historical data feed (e.g., "active").
`message` string	A message indicating the status or progress of the historical data feed process.
`data_files` array	A list of data files available in the historical data feed (e.g., [ "partner-integrations/partner_code/history/2023-12-29_transactions_history_XX01.csv", "partner-integrations/partner_code/history/2023-12-29_positions_history_XX01.csv" ]).
`repcodes` array	A list of rep codes associated with the historical data feed (e.g., ["XX01", "A100"]).