-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add docs for TimeSeries and RNANews connectors (#18)
* Add docs for TimeSeries * Add docs for cumulative return * Add docs for dividend * Add docs for growth * Add docs for price * Add docs for RNANews * Add sections *How to use* and *Relevant demos* to time series docs * Add sections *How to use* and *Relevant demos* to rna news docs * Move morningstar directory into docs/connectors * Rework examples in time-series docs
- Loading branch information
Showing
8 changed files
with
383 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
104 changes: 104 additions & 0 deletions
104
docs/connectors/morningstar/rna-news/regulatory-news-announcements.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,104 @@ | ||
# Regulatory News Announcements (RNANews) | ||
|
||
This type yields series of Regulatory News Announcements for a single security. | ||
|
||
> **NOTE:** RNANews is available in the United Kingdom only. | ||
## How to use RNANews | ||
|
||
Use the `RNANewsConnector` to load regulatory news announcements. | ||
|
||
In dashboards, this connector is called `MorningstarRNANews` | ||
|
||
Specify the security to retrieve in the options along with a postman environment | ||
file for authentication, and other parameters such as `startDate`, `endDate` | ||
or `maxStories`. | ||
|
||
### RNANews with Morningstar standalone for Highcharts: | ||
|
||
```js | ||
const rnaNewsConnector = new Connectors.Morningstar.RNANewsConnector({ | ||
postman: { | ||
environmentJSON: postmanJSON | ||
}, | ||
security: { | ||
id: 'GB00BLGZ9862', | ||
idType: 'ISIN' | ||
}, | ||
startDate: '2000-01-01', | ||
endDate: '2020-12-31', | ||
}); | ||
|
||
await rnaNewsConnector.load(); | ||
|
||
new DataGrid.DataGrid('container', { | ||
dataTable: rnaNewsConnector, | ||
editable: false, | ||
columns: { | ||
Day: { | ||
cellFormatter: function () { | ||
return new Date(this.value) | ||
.toISOString() | ||
.substring(0, 10); | ||
} | ||
} | ||
} | ||
}); | ||
``` | ||
|
||
### RNANews with Morningstar connectors for Dashboards: | ||
|
||
```js | ||
Dashboards.board('container', { | ||
dataPool: { | ||
connectors: [{ | ||
id: 'rna', | ||
type: 'MorningstarRNANews', | ||
options: { | ||
postman: { | ||
environmentJSON: postmanJSON | ||
}, | ||
security: { | ||
id: 'GB00BLGZ9862', | ||
idType: 'ISIN' | ||
}, | ||
startDate: '2000-01-01', | ||
endDate: '2020-12-31' | ||
} | ||
}] | ||
}, | ||
components: [ | ||
{ | ||
renderTo: 'dashboard-col-0', | ||
connector: { | ||
id: 'rna' | ||
}, | ||
type: 'DataGrid', | ||
title: 'Regulatory News for Tesco', | ||
dataGridOptions: { | ||
editable: false, | ||
columns: { | ||
Day: { | ||
cellFormatter: function () { | ||
return new Date(this.value) | ||
.toISOString() | ||
.substring(0, 10); | ||
} | ||
} | ||
} | ||
} | ||
} | ||
] | ||
}); | ||
``` | ||
|
||
For more details, see [Morningstar’s RNANews API]. | ||
|
||
## Relevant demos | ||
|
||
You will find examples of how to use RNANewsConnector in our demos. | ||
|
||
- **Highcharts Dashboards + Morningstar RNA News**: Shows how to use | ||
RNANewsConnector in dashboards to retrieve RNANews for Tesco. | ||
|
||
[Morningstar’s RNANews API]: https://developer.morningstar.com/direct-web-services/documentation/api-reference/time-series/regulatory-news-announcements |
41 changes: 41 additions & 0 deletions
41
docs/connectors/morningstar/time-series/cumulative-return.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# Cumulative Return | ||
|
||
This type yields cumulative return time series data for single or | ||
multiple securities. This data can be used to plot cumulative month end | ||
returns charts. | ||
|
||
Returns cumulative return time series data for securities specified. | ||
|
||
When multiple securities are sent, the start date of the first security | ||
in the list is used as the start date for the series. | ||
|
||
|
||
## How to use Cumulative Return | ||
|
||
In order to fetch a cumulative return, specify series type `CumulativeReturn` in | ||
the Time Series Connector options. | ||
|
||
```js | ||
const cumulReturnConnector = new Connectors.Morningstar.TimeSeriesConnector({ | ||
postman: { | ||
environmentJSON: postmanJSON | ||
}, | ||
series: { | ||
type: 'CumulativeReturn' | ||
}, | ||
securities: [{ | ||
id: 'F0GBR04S23', | ||
idType: 'MSID' | ||
}] | ||
}); | ||
``` | ||
|
||
For more details, see [Morningstar’s Time Series API]. | ||
|
||
## Relevant demos | ||
|
||
- **Highcharts Stock + Morningstar TimeSeries**: Shows how to use | ||
TimeSeriesConnector to retrieve Price time series. Specify type | ||
`CumulativeReturn`. | ||
|
||
[Morningstar’s Time Series API]: https://developer.morningstar.com/direct-web-services/documentation/api-reference/time-series/cumulative-return |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# Dividend | ||
|
||
This type yields dividend time series data for single or multiple securities. | ||
|
||
Returns rolling return time series data for securities specified. | ||
|
||
When multiple securities are sent, the start date of the first security | ||
in the list is used as the start date for the series. | ||
|
||
## How to use Dividend | ||
|
||
In order to fetch a dividend time series, specify series type | ||
`Dividend` in the Time Series Connector options. | ||
|
||
```js | ||
const dividendConnector = new Connectors.Morningstar.TimeSeriesConnector({ | ||
postman: { | ||
environmentJSON: postmanJSON | ||
}, | ||
series: { | ||
type: 'Dividend' | ||
}, | ||
securities: [{ | ||
id: 'F0GBR04S23', | ||
idType: 'MSID' | ||
}] | ||
}); | ||
``` | ||
|
||
For more details, see [Morningstar’s Time Series API]. | ||
|
||
## Relevant demos | ||
|
||
- **Highcharts Stock + Morningstar TimeSeries**: Shows how to use | ||
TimeSeriesConnector to retrieve Price time series. Specify type | ||
`Dividend`. | ||
|
||
[Morningstar’s Time Series API]: https://developer.morningstar.com/direct-web-services/documentation/api-reference/time-series/dividend |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Growth | ||
|
||
This type yields growth time series data for single or multiple securities. | ||
This data can be used to plot growth charts. | ||
|
||
Returns growth time series data for securities specified. | ||
|
||
When multiple securities are sent, the start date of the first security | ||
in the list is used as the start date for the series. | ||
|
||
|
||
## How to use Growth | ||
|
||
In order to fetch time series for growth, specify series type `Growth` in | ||
the Time Series Connector options. | ||
|
||
```js | ||
const growthConnector = new Connectors.Morningstar.TimeSeriesConnector({ | ||
postman: { | ||
environmentJSON: postmanJSON | ||
}, | ||
series: { | ||
type: 'Growth' | ||
}, | ||
securities: [{ | ||
id: 'F0GBR04S23', | ||
idType: 'MSID' | ||
}] | ||
}); | ||
``` | ||
|
||
For more details, see [Morningstar’s Time Series API]. | ||
|
||
## Relevant demos | ||
|
||
- **Highcharts Stock + Morningstar TimeSeries**: Shows how to use | ||
TimeSeriesConnector to retrieve Price time series. Specify type | ||
`Growth`. | ||
|
||
[Morningstar’s Time Series API]: https://developer.morningstar.com/direct-web-services/documentation/api-reference/time-series/growth |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# Price | ||
|
||
Get price time series data for single or multiple securities. | ||
|
||
Returns price series data for securities specified, based on Market data | ||
entitlement. | ||
|
||
When multiple securities are sent, the start date of the first security | ||
in the list is used as the start date for the series. | ||
|
||
## How to use Price | ||
|
||
In order to fetch price time series, specify series type `Price` in | ||
the Time Series Connector options. | ||
|
||
```js | ||
const priceConnector = new Connectors.Morningstar.TimeSeriesConnector({ | ||
postman: { | ||
environmentJSON: postmanJSON | ||
}, | ||
series: { | ||
type: 'Price' | ||
}, | ||
securities: [{ | ||
id: 'F0GBR04S23', | ||
idType: 'MSID' | ||
}] | ||
}); | ||
``` | ||
|
||
For more details, see [Morningstar’s Time Series API]. | ||
|
||
## Relevant demos | ||
|
||
- **Highcharts Stock + Morningstar TimeSeries**: Shows how to use | ||
TimeSeriesConnector to retrieve Price time series. | ||
|
||
[Morningstar’s Time Series API]: https://developer.morningstar.com/direct-web-services/documentation/api-reference/time-series/price |
Oops, something went wrong.