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
+28-19Lines changed: 28 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,20 @@
1
1
# RKD HTTP JSON with Python Example
2
-
## Overview
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.
The [Refinitiv Knowledge Direct (RKD) API](https://developers.refinitiv.com/en/api-catalog/refinitiv-knowledge-direct/refinitiv-knowledge-direct-api-rkd-api) (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
10
5
11
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
12
7
13
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
14
9
15
*Note:* The Jupyter Notebook example does not contain all the same RKD services service as console examples yet. [TBD]
10
16
11
-
## Application Files
17
+
## <aid="project_files"></a>Application Files
12
18
This project contains the following example scripts for each RKD services
13
19
- trkd_authen.py: An example application that shows how to authenticate with RKD service
14
20
- trkd_quote.py: An example application that shows how to subscribe (all fields and specific fields) the Quote data from RKD service
@@ -27,7 +33,7 @@ This project contains the following example scripts for each RKD services
27
33
28
34
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.
29
35
30
-
## Prerequisite
36
+
## <aid="prerequisite"></a>Prerequisite
31
37
The following softwares are required to use this script
32
38
- RKD API credentials. Please reach out to your Refinitiv sales associate to acquire RKD access credentials.
33
39
-[Python 3](https://www.python.org/).
@@ -41,13 +47,13 @@ All scripts support Python 3 only and not compatible with Python 2.
41
47
*Note:*
42
48
- 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.
43
49
44
-
## How to run the script
50
+
## <aid="run_console"></a>How to run the script
45
51
Run the script via the command line (or shell)
46
52
```
47
53
$>python <application>.py
48
54
```
49
55
50
-
## Optional - How to install libraries for console examples
56
+
## <aid="library_install"></a>Optional - How to install libraries for console examples
51
57
The best way is via the pip package management tool
52
58
1. export <Python_folder>\Scripts to your OS PATH environment
53
59
2. call pip command to install requests
@@ -62,30 +68,30 @@ The best way is via the pip package management tool
62
68
63
69
*Note*: If you aim to use only RKD HTTP JSON services, you can just install requests library via a ```pip install requests``` command.
64
70
65
-
## Optional - How to install libraries for notebook examples
71
+
## <aid="run_notebook"></a>Optional - How to install libraries for notebook examples
66
72
Please follow the [classic Jupyter Notebook installation guide](https://jupyter.org/install) page.
67
73
68
-
## RDP and ERT in Cloud
74
+
## <aid="rdp"></a>RDP and Refinitiv Real-Time - Optimized
69
75
70
-
You may consider the strategic [Refinitiv Data Platform (RDP)](https://developers.refinitiv.com/refinitiv-data-platform) web base APIs platform. RDP APIs give you seamless and holistic access to all of Refinitiv content such as Historical Pricing, Environmental Social and Governance (ESG), News, Research, etc and commingled with your own content, enriching, integrating and distributing the data through a single interface, delivered wherever you need it. The RDP APIs delivery mechanisms are following:
76
+
You may consider the strategic [Refinitiv Data Platform (RDP)](https://developers.refinitiv.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-platform-apis) web base APIs platform. RDP APIs give you seamless and holistic access to all of Refinitiv content such as Historical Pricing, Environmental Social and Governance (ESG), News, Research, etc and commingled with your own content, enriching, integrating and distributing the data through a single interface, delivered wherever you need it. The RDP APIs delivery mechanisms are following:
71
77
* Request - Response: RESTful web service (HTTP GET, POST, PUT or DELETE)
72
78
* Alert: delivery is a mechanism to receive asynchronous updates (alerts) to a subscription.
73
79
* Bulks: deliver substantial payloads, like the end of day pricing data for the whole venue.
74
80
* Streaming: deliver real-time delivery of messages.
75
81
76
-
Please see [RDP API Overview page](https://developers.refinitiv.com/refinitiv-data-platform/refinitiv-data-platform-apis) for more detail.
82
+
Please see [RDP APIs Overview page](https://developers.refinitiv.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-platform-apis) for more detail.
77
83
78
-
As part of RDP, [Elektron RealTime 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).
84
+
As part of RDP, [Refinitiv Real-Time - Optimized (RRTO)](https://developers.refinitiv.com/en/api-catalog/refinitiv-real-time-opnsrc/refinitiv-websocket-api/tutorials#connect-to-refinitiv-real-time-optimized) gives you access to best in class Real Time market data delivered in the cloud. RRTO is a new delivery mechanism for RDP, using the AWS (Amazon Web Services) cloud. Once a connection to RDP is established using RRTO, data can be retrieved using [WebSocket API](https://developers.refinitiv.com/en/api-catalog/refinitiv-real-time-opnsrc/refinitiv-websocket-api) (the same as RKD Streaming Service).
79
85
80
-
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.
86
+
Key benefit of the strategic RDP and RRTO 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 RRTO support output for multiple cloud vendors such as AWS, Azure, GCS, etc. for cloud-native or on-premise integration. The RRTO servers are hosted in multiple location world-wide which lets the application choose the closest server based on their region for full potential.
81
87
82
-
## References
88
+
## <aid="references"></a>References
83
89
For further details, please check out the following resources:
84
-
*[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.
85
-
*[Refinitiv Knowledge Direct API Catalog](https://www.trkd.thomsonreuters.com/SupportSite/RequestBuilder/requestbuilder.aspx) web site.
86
-
*[Elektron WebSocket API](https://developers.refinitiv.com/websocket-api) page on the [Refinitiv Developers Community](https://developers.refinitiv.com/) web site.
87
-
*[Refinitiv Data Platform (RDP) APIs page](https://developers.refinitiv.com/refinitiv-data-platform).
88
-
*[Refinitiv Data Platform (RDP) APIs Gateway page](https://api.refinitiv.com).
90
+
*[Refinitiv Knowledge Direct API page](https://developers.refinitiv.com/en/api-catalog/refinitiv-knowledge-direct/refinitiv-knowledge-direct-api-rkd-api) on the [Refinitiv Developers Community](https://developers.refinitiv.com/) web site.
91
+
*[Refinitiv Knowledge Direct API Catalog](https://support-portal.rkd.refinitiv.com/SupportSite/TestApi/Catalog) web site.
92
+
*[WebSocket API](https://developers.refinitiv.com/websocket-api) page on the [Refinitiv Developers Community](https://developers.refinitiv.com/) web site.
93
+
*[Refinitiv Data Platform (RDP) APIs page](https://developers.refinitiv.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-platform-apis).
94
+
*[Refinitiv Data Platform (RDP) APIs Gateway page](https://apidocs.refinitiv.com/Apps/ApiDocs).
89
95
90
96
## Release Note
91
97
- Version 1: 6 Sep 2016
@@ -134,7 +140,10 @@ For further details, please check out the following resources:
134
140
- version 1.5.2: October 2019
135
141
- Update TRKD Interday and Intraday services operations.
136
142
- version 1.5.3: May 2020
137
-
- Update RDP and ERT in Cloud information.
143
+
- Update RDP and Refinitiv Real-Time - Optimized information.
0 commit comments