Skip to content

Commit

Permalink
added security details docs (#49)
Browse files Browse the repository at this point in the history
  • Loading branch information
bm64 authored Nov 29, 2024
1 parent 741d1e3 commit 608f4f8
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/connectors/morningstar.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,4 @@ types.
* [Risk Score](morningstar/risk-score.md)
* [TimeSeries](morningstar/time-series/time-series.md)
* [XRay](morningstar/x-ray.md)
* [Security Details](morningstar/security-details.md)
60 changes: 60 additions & 0 deletions docs/connectors/morningstar/security-details.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Security Details

This type retrieves investment data for a specified set of securities and is ideal for building single-investment profiles.

## How to use SecurityDetails

Use the `SecurityDetailsConnector` to load security details.

In dashboards, this connector is called `MorningstarSecurityDetails`.

Specify the securities in the options along with a Postman environment file for authentication and other parameters such as and `currency`.

### Securities

Securities are the investments whose details are retrieved. They can be specified using various ID types.

Supported id-types are: `CUSIP`, `FundCode`, `ISIN`, `MSID`, `PerformanceId`, `SecurityID`, `TradingSymbol`.

If any securities are invalid, the connector will still yield results. The invalid securities will appear in the connector's `metadata` after load.

For more details, see [Morningstar’s Security Details API].

### Security Details with Morningstar standalone for Highcharts:

```js
const securityDetailsConnector = new Connectors.Morningstar.SecurityDetailsConnector({
postman: {
environmentJSON: postmanJSON
},
security: {
id: 'F0GBR050DD',
idType: 'MSID'
}
});

await securityDetailsConnector.load();

Highcharts.chart('container', {
title: {
text: 'Aviva Investors UK Listed Equity Unconstrained Fund 2 GBP Acc'
},
series: [{
type: 'column',
name: 'F0GBR050DD',
data: connector.table.getRowObjects().map(obj => [
obj.SecurityDetails_TrailingPerformance_TimePeriod,
obj.SecurityDetails_TrailingPerformance_Value
])
}],
xAxis: {
type: 'category'
}
});
```

## Relevant demo

You will find examples of how to use SecurityDetailsConnector in our demos.

[Morningstar’s Security Details API]: https://developer.morningstar.com/direct-web-services/documentation/api-reference/security-details/overview

0 comments on commit 608f4f8

Please sign in to comment.