Data Feed
Data feed is a file-based process of exporting Altruist users' data files.
The Data Feed API provides a set of endpoints that enables the management of data feeds for the current user. With this API, you can enable, retrieve the status of, and disable data feeds associated with a partner_code and feed_id.
Preparatory Steps
1. Request access to Data Feed API
If you would like to use the 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 data feed API. After making the API requests to the designated endpoints, the 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.
To activate a 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 data feed for the current user. Upon successful activation, the API will provide comprehensive details regarding the data feed, including the ID, the data feed status, a message notifying the feed's initiation, and a list of associated data files and rep codes.
Request Headers
Authorization required | The access token. |
Request Parameters
partner_code string, required | The unique partner code. |
Request Body Object
file_transfer string, required | The attribute enables the data feed. Expected value: 'on' |
Response Object Fields
id string | A unique identifier for the data feed. |
data_feed_status string | The status of the data feed (e.g., "active"). |
message string | A message indicating the status or progress of the data feed process. |
data_files array | A list of data files available in the data feed (e.g., ["Demographics", "Positions", "Transactions"]). |
repcodes array | A list of rep codes associated with the data feed (e.g., ["A100"]). |
This endpoint allows users to retrieve a list of data feeds for the current user.
Request Headers
Authorization required | The access token. |
Request Parameters
partner_code string, required | The unique partner code. |
X-API-Request-ID string | The house-hold provided request ID. |
Response Object Fields
id string | A unique identifier for the data feed. |
data_feed_status string | The status of the data feed (e.g., "active"). |
message string | A message indicating the status or progress of the data feed process. |
data_files array | A list of data files available in the data feed (e.g., ["Demographics", "Positions", "Transactions"]). |
repcodes array | A list of representative codes associated with the data feed (e.g., ["A100"]). |
To check the status of a data feed, simply send a GET request with the partner code and feed ID. This will retrieve the current status of the specified data feed, including details such as ID, status, message, data files, and representative codes. This endpoint supports HTTP GET method and allows you to retrieve the status of a specific data feed associated with the given feed_id. The message attribute is optional in the response.
Request Headers
Authorization required | The access token. |
Request Parameters
partner_code string, required | The unique partner code. |
feed_id string, required | The ID of the data feed. |
Response Object Fields
id string | A unique identifier for the data feed. |
data_feed_status string | The status of the data feed (e.g., "active"). |
message string | A message indicating the status or progress of the data feed process. |
data_files array | A list of data files available in the data feed (e.g., ["Demographics", "Positions", "Transactions"]). |
repcodes array | A list of representative codes associated with the data feed (e.g., ["A100"]). |
To disable a data feed, utilize the DELETE endpoint. This endpoint permits you to turn off the data feed connected with the partner code and feed ID provided. After successful disabling, the API will respond with a status code of 204, indicating that the data feed is now disabled. This endpoint utilizes HTTP DELETE method and deactivates the specified data feed associated with the given code. No content is returned upon successful disabling of the data feed.
Request Headers
Authorization required | The access token. |
Request Parameters
partner_code string, required | The unique partner code. |
feed_id string, required | The ID of the data feed. |
Response
No content is returned when the data feed is disabled.
Updated over 1 year ago