You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+30-30Lines changed: 30 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,43 +1,43 @@
1
-
# TRKD HTTP JSON with Python Example
1
+
# RKD HTTP JSON with Python Example
2
2
## Overview
3
-
The [Refnitiv Knowledge Direct (TRKD) API](https://developers.refinitiv.com/thomson-reuters-knowledge-direct-trkd) integrates into your website, trading platform, company intranet/extranet, advisory portal and mobile applications to provide up-to-date financial market data, news and analytics and powerful investment tools.
3
+
The [Refinitiv Knowledge Direct (RKD) API](https://developers.refinitiv.com/thomson-reuters-knowledge-direct-trkd)(formerly known as TRKD API)integrates into your website, trading platform, company intranet/extranet, advisory portal and mobile applications to provide up-to-date financial market data, news and analytics and powerful investment tools.
4
4
5
-
TRKD offers a wide range of Refinitiv' information and services delivered in a request-response scenario via web services using today's industry standard protocols (SOAP/XML and REST/JSON). Connectivity can be via HTTP and HTTPS, over the Internet or Delivery Direct. All data are snapshot (non-streaming) data.
5
+
RKD offers a wide range of Refinitiv' information and services delivered in a request-response scenario via web services using today's industry standard protocols (SOAP/XML and REST/JSON). Connectivity can be via HTTP and HTTPS, over the Internet or Delivery Direct. All data are snapshot (non-streaming) data.
6
6
7
-
This is an example project that shows how to implement TRKD HTTP JSON client and TRKD Streaming client with Python programming lanugage. The project example are in both console and Jupyter Notebook applications.
7
+
This is an example project that shows how to implement RKD HTTP JSON client and RKD Streaming client with Python programming language. The project example are in both console and Jupyter Notebook applications.
8
8
9
-
*Note:* The Jupyter Notebook example does not contain all the same TRKD services service as console examples yet. [TBD]
9
+
*Note:* The Jupyter Notebook example does not contain all the same RKD services service as console examples yet. [TBD]
10
10
11
11
## Application Files
12
-
This project contains the following example scripts for each TRKD services
13
-
- trkd_authen.py: An example application that shows how to authenticate with TRKD service
14
-
- trkd_quote.py: An example application that shows how to subscribe (all fields and specific fields) the Quote data from TRKD service
15
-
- trkd_newsheadline.py: An example application that shows how to subscribe the News Headline data from TRKD service
16
-
- trkd_newsstory.py: An example application that shows how to subscribe the News Story data from TRKD service
17
-
- trkd_intraday.py: An example application that shows how to subscribe the Intraday Time-series data from TRKD service
18
-
- trkd_interday.py: An example application that shows how to subscribe the Interday Time-series data from TRKD service
19
-
- trkd_onlinereport.py: An example application that shows how to subscribe the Online Report data from TRKD service
20
-
- trkd_chart.py: An example application that shows how to subscribe and download the Chart image data from TRKD service
21
-
- trkd_wsstreaming.py: An example application that show how to subscribe the Quote data from TRKD Streming service via a WebSocket connection
12
+
This project contains the following example scripts for each RKD services
13
+
- trkd_authen.py: An example application that shows how to authenticate with RKD service
14
+
- trkd_quote.py: An example application that shows how to subscribe (all fields and specific fields) the Quote data from RKD service
15
+
- trkd_newsheadline.py: An example application that shows how to subscribe the News Headline data from RKD service
16
+
- trkd_newsstory.py: An example application that shows how to subscribe the News Story data from RKD service
17
+
- trkd_intraday.py: An example application that shows how to subscribe the Intraday Time-series data from RKD service
18
+
- trkd_interday.py: An example application that shows how to subscribe the Interday Time-series data from RKD service
19
+
- trkd_onlinereport.py: An example application that shows how to subscribe the Online Report data from RKD service
20
+
- trkd_chart.py: An example application that shows how to subscribe and download the Chart image data from RKD service
21
+
- trkd_wsstreaming.py: An example application that show how to subscribe the Quote data from RKD Streaming service via a WebSocket connection
22
22
- notebook folder:
23
-
- *notebook/trkd_authentication.ipynb*: A Jupyter Notebook TRKD Authentication service example
24
-
- *notebook/trkd_timeseries_interday.ipynb*: A Jupyter Notebook TRKD Time-Series Interday service example
25
-
- *notebook/trkd_timeseries_intraday.ipynb*: A Jupyter Notebook TRKD Time-Series Intraday service example
23
+
- *notebook/trkd_authentication.ipynb*: A Jupyter Notebook RKD Authentication service example
24
+
- *notebook/trkd_timeseries_interday.ipynb*: A Jupyter Notebook RKD Time-Series Interday service example
25
+
- *notebook/trkd_timeseries_intraday.ipynb*: A Jupyter Notebook RKD Time-Series Intraday service example
26
26
- requestments.txt: A requirement file contains a list of required libraries for HTTP JSON and WebSocket connections.
27
27
- docs\TRKD_REST_with_Python.docx: A document that describes the trkd_authen.py and trkd_quote.py applications
28
28
29
-
All source code and scripts are provided under the Apache 2.0 license. Thye are provided AS IS with no warranty or guarantee of fit for purpose. See the project's LICENSE.md for details.
29
+
All source code and scripts are provided under the Apache 2.0 license. They are provided AS IS with no warranty or guarantee of fit for purpose. See the project's LICENSE.md for details.
30
30
31
31
## Prerequisite
32
32
The following softwares are required to use this script
33
-
-TRKD API credentials. Please reach out to your Refinitiv sales associate to acquire TRKD access credentials.
33
+
-RKD API credentials. Please reach out to your Refinitiv sales associate to acquire RKD access credentials.
34
34
- Python 3
35
35
- The [requests](http://docs.python-requests.org/en/master/) library
36
36
- The [websocket-client](https://pypi.org/project/websocket-client/) library (*version 0.49 or greater*, for trkd_wsstreaming.py application only)
37
37
- The [python-dateutil](https://pypi.org/project/python-dateutil/) library (for trkd_wsstreaming.py application only)
38
38
- The [classic Jupyter Notebook](https://jupyter.org/) runtime (for the Notebook example application)
39
39
40
-
All scripts support Python 3 and not compatible with Python 2.
40
+
All scripts support Python 3 only and not compatible with Python 2.
41
41
42
42
*Note:*
43
43
- You can install Jupyter Notebook on your local machine and then test the example on the machine. The alternate choice is a free Jupyter Notebook on cloud environment such as [Azure Notebook](https://notebooks.azure.com/) provided by Microsoft. You can find more details from [this tutorial](https://docs.microsoft.com/en-us/azure/notebooks/tutorial-create-run-jupyter-notebook). If you are not familiar with Jupyter Notebook, the following [tutorial](https://www.datacamp.com/community/tutorials/tutorial-jupyter-notebook) created by DataCamp may help.
@@ -53,15 +53,15 @@ The best way is via the pip package management tool
53
53
1. export <Python_folder>\Scripts to your OS PATH environment
54
54
2. call pip command to install requests
55
55
```
56
-
$>pip install -r requestments.txt
56
+
$>pip install -r requirements.txt
57
57
```
58
58
3. If you are behind proxy, set the proxy first
59
59
```
60
60
export https_proxy="http://<proxy.server>:<port>"
61
-
$>pip install -r requestments.txt
61
+
$>pip install -r requirements.txt
62
62
```
63
63
64
-
*Note*: If you aim to use only TRKD HTTP JSON services, you can just install requests library via a ```pip install requests``` command.
64
+
*Note*: If you aim to use only RKD HTTP JSON services, you can just install requests library via a ```pip install requests``` command.
65
65
66
66
## Optional - How to install libraries for notebook examples
67
67
Please follow the [classic Jupyter Notebook installation guide](https://jupyter.org/install) page.
@@ -76,13 +76,10 @@ You may consider the strategic [Refinitiv Data Platform (RDP)](https://developer
76
76
77
77
Please see [RDP API Overview page](https://developers.refinitiv.com/refinitiv-data-platform/refinitiv-data-platform-apis) for more detail.
78
78
79
-
As part of RDP, [Elektron Real Time in Cloud (ERT in Cloud)](https://developers.thomsonreuters.com/elektron/websocket-api/quick-start?content=45253&type=quick_start) gives you access to best in class Real Time market data delivered in the cloud. ERT in Cloud is a new delivery mechanism for RDP, using the AWS (Amazon Web Services) cloud. Once a connection to RDP is established using ERT in Cloud, data can be retrieved using [Elektron WebSocket API](https://developers.thomsonreuters.com/websocket-api) (the same as TRKD Streaming Service).
79
+
As part of RDP, [Elektron Real Time in Cloud (ERT in Cloud)](https://developers.thomsonreuters.com/elektron/websocket-api/quick-start?content=45253&type=quick_start) gives you access to best in class Real Time market data delivered in the cloud. ERT in Cloud is a new delivery mechanism for RDP, using the AWS (Amazon Web Services) cloud. Once a connection to RDP is established using ERT in Cloud, data can be retrieved using [Elektron WebSocket API](https://developers.thomsonreuters.com/websocket-api) (the same as RKD Streaming Service).
80
80
81
81
Key benefit of the strategic RDP and ERT in Cloud platform are the Cloud Delivery. The Platform is based on [Amazon AWS](https://aws.amazon.com/), the world class leading Cloud Provider for developers. The RDP and ERT in Cloud support output for multiple cloud vendors such as AWS, Azure, GCS, etc. for cloud-native or on-premise integration. The ERT in Cloud servers are hosted in multiple location world-wide which lets the application choose the closest server based on their region for full potential.
82
82
83
-
Please refer to [Elektron WebSocket API Quick Start - Connecting to Elektron Real Time in Cloud](https://developers.refinitiv.com/elektron/websocket-api/quick-start?content=45253&type=quick_start) page and [How to migrate the WebSocket application from TRKD Streaming service to Elektron Real Time in Cloud](https://developers.refinitiv.com/article/how-migrate-websocket-application-trkd-streaming-service-elektron-real-time-cloud) article for more detail.
84
-
85
-
86
83
## References
87
84
For further details, please check out the following resources:
88
85
*[Refinitiv Knowledge Direct API page](https://developers.refinitiv.com/thomson-reuters-knowledge-direct-trkd) on the [Refinitiv Developers Community](https://developers.refinitiv.com/) web site.
@@ -109,9 +106,9 @@ For further details, please check out the following resources:
109
106
- docs\TRKD_REST_with_Python.docx.
110
107
- revise some code.
111
108
- version 1.0.5: 27 Apr 2017
112
-
- revies README.md to support markdown.
109
+
- revise README.md to support markdown.
113
110
- version 1.0.6: 3 May 2017
114
-
- revies README.md.
111
+
- revise README.md.
115
112
- modify trkd_authen.py.
116
113
- modify trkd_quote.py.
117
114
- version 1.0.7: 9 May 2017
@@ -139,3 +136,6 @@ For further details, please check out the following resources:
139
136
- Update TRKD Interday and Intraday services operations.
0 commit comments