If you plan on supplying us with constituent data you hold on-site, for example, custom baskets or Index data used elsewhere within the business, you should supply this using the endpoint:
https://{environment_name}-api.fundapps.co/v3/data/composites/upload
<aside>
🚧
If you use SFTP to upload Data Adapter files, you can also use this method to pass BYOD composite data. The relevant information to set this up is on your SFTP settings screen, which is visible in the UI. For more details, contact support or your Implementation Manager.
</aside>
Where {environment_name}is replaced with your FundApps tenant name
- Use a POST request
- Authenticate using the same FundApps engine API credentials used for file upload currently, in Basic Authentication format
- Upload a CSV (format below) in the body using a
composites key and a Content-Type of multipart/form-data
- CSV format. Please use a comma
, as a separator. The table format is representative of the columns and data format.
- All data in this file is case-sensitive
| CompositeId |
CompositeIdType |
ComponentId |
ComponentIdType |
Weighting |
WeightingQuantity |
| .KS100EWI |
DataProviderId |
005930.KS |
DataProviderId |
0.2 |
1000000 |
| .KS100EWI |
DataProviderId |
KR7005930003 |
Isin |
0.3 |
|
| KOSPI100 Index |
DataProviderId |
005930 KS Equity |
DataProviderId |
|
4001 |
| BBG000P5WLC5 |
Figi |
DK0062498333 |
Isin |
0.1 |
|
- CompositeIdType and ComponentIdType fields are used to define the identifier you wish to match the parent/constituent across your BYOD File and your daily Positions File. The supported values are:
- InstrumentId (can only be used for clients uploading XML / ExPost )
- DataProviderId (can only be used for clients uploading the Data Adapter CSV Positions File)
- Isin
- Sedol
- Cusip
- Figi
- Weighting or WeightingQuantity should be used, and each is defined within the InstrumentComponent Properties section on this page.
BYOD File Validation
- You can specify additional fields within this CSV, they will be ignored for processing
- WeightingQuantity should be provided as a positive value greater than 0
- Weighting and/or WeightingQuantity must be set for each row
- BYOD data is persisted until the next BYOD upload occurs, you do not need to upload it each day or run of the service
- Partial BYOD uploads are not supported. Uploading a new BYOD file will replace all existing BYOD data in full
- If the file passes validation you should see a return status of 201 with a message:
{
"message": "Upload Successful"
}