From 608f4f8f6819432d1d3042383f7fd2aade226797 Mon Sep 17 00:00:00 2001
From: Mateusz Bernacik <mat.bernacik@gmail.com>
Date: Fri, 29 Nov 2024 11:04:43 +0100
Subject: [PATCH] added security details docs (#49)

---
 docs/connectors/morningstar.md                |  1 +
 .../morningstar/security-details.md           | 60 +++++++++++++++++++
 2 files changed, 61 insertions(+)
 create mode 100644 docs/connectors/morningstar/security-details.md

diff --git a/docs/connectors/morningstar.md b/docs/connectors/morningstar.md
index 800abc1..74bb696 100644
--- a/docs/connectors/morningstar.md
+++ b/docs/connectors/morningstar.md
@@ -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)
diff --git a/docs/connectors/morningstar/security-details.md b/docs/connectors/morningstar/security-details.md
new file mode 100644
index 0000000..99367af
--- /dev/null
+++ b/docs/connectors/morningstar/security-details.md
@@ -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
\ No newline at end of file