162 lines
8.6 KiB
Plaintext
162 lines
8.6 KiB
Plaintext
---
|
||
title: DataOnDemandProvider
|
||
description: API reference for qiskit.finance.data_providers.DataOnDemandProvider
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.finance.data_providers.DataOnDemandProvider
|
||
---
|
||
|
||
<span id="qiskit-finance-data-providers-dataondemandprovider" />
|
||
|
||
# qiskit.finance.data\_providers.DataOnDemandProvider
|
||
|
||
<Class id="qiskit.finance.data_providers.DataOnDemandProvider" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/finance/data_providers/data_on_demand_provider.py" signature="DataOnDemandProvider(token, tickers, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), verify=None)" modifiers="class">
|
||
NASDAQ Data on Demand data provider.
|
||
|
||
Please see: [https://github.com/Qiskit/qiskit-tutorials/blob/master/legacy\_tutorials/aqua/finance/data\_providers/time\_series.ipynb](https://github.com/Qiskit/qiskit-tutorials/blob/master/legacy_tutorials/aqua/finance/data_providers/time_series.ipynb) for instructions on use, which involve obtaining a NASDAQ DOD access token.
|
||
|
||
**Parameters**
|
||
|
||
* **token** (`str`) – data on demand access token
|
||
* **tickers** (`Union`\[`str`, `List`\[`str`]]) – tickers
|
||
* **start** (`datetime`) – first data point
|
||
* **end** (`datetime`) – last data point precedes this date
|
||
* **verify** (`Union`\[`str`, `bool`, `None`]) – if verify is None, certify certificates will be used (default); if this is False, no certificates will be checked; if this is a string, it should be pointing to a certificate for the HTTPS connection to NASDAQ (dataondemand.nasdaq.com), either in the form of a CA\_BUNDLE file or a directory wherein to look.
|
||
|
||
### \_\_init\_\_
|
||
|
||
<Function id="qiskit.finance.data_providers.DataOnDemandProvider.__init__" signature="__init__(token, tickers, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), verify=None)">
|
||
**Parameters**
|
||
|
||
* **token** (`str`) – data on demand access token
|
||
* **tickers** (`Union`\[`str`, `List`\[`str`]]) – tickers
|
||
* **start** (`datetime`) – first data point
|
||
* **end** (`datetime`) – last data point precedes this date
|
||
* **verify** (`Union`\[`str`, `bool`, `None`]) – if verify is None, certify certificates will be used (default); if this is False, no certificates will be checked; if this is a string, it should be pointing to a certificate for the HTTPS connection to NASDAQ (dataondemand.nasdaq.com), either in the form of a CA\_BUNDLE file or a directory wherein to look.
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
||
| [`__init__`](#qiskit.finance.data_providers.DataOnDemandProvider.__init__ "qiskit.finance.data_providers.DataOnDemandProvider.__init__")(token, tickers\[, start, end, verify]) | **type token**`str` |
|
||
| [`get_coordinates`](#qiskit.finance.data_providers.DataOnDemandProvider.get_coordinates "qiskit.finance.data_providers.DataOnDemandProvider.get_coordinates")() | Returns random coordinates for visualisation purposes. |
|
||
| [`get_covariance_matrix`](#qiskit.finance.data_providers.DataOnDemandProvider.get_covariance_matrix "qiskit.finance.data_providers.DataOnDemandProvider.get_covariance_matrix")() | Returns the covariance matrix. |
|
||
| [`get_mean_vector`](#qiskit.finance.data_providers.DataOnDemandProvider.get_mean_vector "qiskit.finance.data_providers.DataOnDemandProvider.get_mean_vector")() | Returns a vector containing the mean value of each asset. |
|
||
| [`get_period_return_covariance_matrix`](#qiskit.finance.data_providers.DataOnDemandProvider.get_period_return_covariance_matrix "qiskit.finance.data_providers.DataOnDemandProvider.get_period_return_covariance_matrix")() | Returns a vector containing the mean value of each asset. |
|
||
| [`get_period_return_mean_vector`](#qiskit.finance.data_providers.DataOnDemandProvider.get_period_return_mean_vector "qiskit.finance.data_providers.DataOnDemandProvider.get_period_return_mean_vector")() | Returns a vector containing the mean value of each asset. |
|
||
| [`get_similarity_matrix`](#qiskit.finance.data_providers.DataOnDemandProvider.get_similarity_matrix "qiskit.finance.data_providers.DataOnDemandProvider.get_similarity_matrix")() | Returns time-series similarity matrix computed using dynamic time warping. |
|
||
| [`run`](#qiskit.finance.data_providers.DataOnDemandProvider.run "qiskit.finance.data_providers.DataOnDemandProvider.run")() | Loads data, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. |
|
||
|
||
### get\_coordinates
|
||
|
||
<Function id="qiskit.finance.data_providers.DataOnDemandProvider.get_coordinates" signature="get_coordinates()">
|
||
Returns random coordinates for visualisation purposes.
|
||
|
||
**Return type**
|
||
|
||
`Tuple`\[`float`, `float`]
|
||
</Function>
|
||
|
||
### get\_covariance\_matrix
|
||
|
||
<Function id="qiskit.finance.data_providers.DataOnDemandProvider.get_covariance_matrix" signature="get_covariance_matrix()">
|
||
Returns the covariance matrix.
|
||
|
||
**Return type**
|
||
|
||
`ndarray`
|
||
|
||
**Returns**
|
||
|
||
an asset-to-asset covariance matrix.
|
||
|
||
**Raises**
|
||
|
||
[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded
|
||
</Function>
|
||
|
||
### get\_mean\_vector
|
||
|
||
<Function id="qiskit.finance.data_providers.DataOnDemandProvider.get_mean_vector" signature="get_mean_vector()">
|
||
Returns a vector containing the mean value of each asset.
|
||
|
||
**Return type**
|
||
|
||
`ndarray`
|
||
|
||
**Returns**
|
||
|
||
a per-asset mean vector.
|
||
|
||
**Raises**
|
||
|
||
[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded
|
||
</Function>
|
||
|
||
### get\_period\_return\_covariance\_matrix
|
||
|
||
<Function id="qiskit.finance.data_providers.DataOnDemandProvider.get_period_return_covariance_matrix" signature="get_period_return_covariance_matrix()">
|
||
Returns a vector containing the mean value of each asset.
|
||
|
||
**Return type**
|
||
|
||
`ndarray`
|
||
|
||
**Returns**
|
||
|
||
a per-asset mean vector.
|
||
|
||
**Raises**
|
||
|
||
[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded
|
||
</Function>
|
||
|
||
### get\_period\_return\_mean\_vector
|
||
|
||
<Function id="qiskit.finance.data_providers.DataOnDemandProvider.get_period_return_mean_vector" signature="get_period_return_mean_vector()">
|
||
Returns a vector containing the mean value of each asset.
|
||
|
||
**Return type**
|
||
|
||
`ndarray`
|
||
|
||
**Returns**
|
||
|
||
a per-asset mean vector.
|
||
|
||
**Raises**
|
||
|
||
[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded
|
||
</Function>
|
||
|
||
### get\_similarity\_matrix
|
||
|
||
<Function id="qiskit.finance.data_providers.DataOnDemandProvider.get_similarity_matrix" signature="get_similarity_matrix()">
|
||
Returns time-series similarity matrix computed using dynamic time warping.
|
||
|
||
**Return type**
|
||
|
||
`ndarray`
|
||
|
||
**Returns**
|
||
|
||
an asset-to-asset similarity matrix.
|
||
|
||
**Raises**
|
||
|
||
[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded
|
||
</Function>
|
||
|
||
### run
|
||
|
||
<Function id="qiskit.finance.data_providers.DataOnDemandProvider.run" signature="run()">
|
||
Loads data, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class.
|
||
|
||
**Return type**
|
||
|
||
`None`
|
||
</Function>
|
||
</Class>
|
||
|