Retrieving Services Availability with Websocket API
Hi team, I am currently using Websocket API with Python and trying to get a response from the ADS server about available services to be using by the application at a certain point in time.
The expected results are like mapping "ServiceName" with "State", when accessing ADSMON >> Services Statistics. For example:
- ELEKTRON_DD : UP
- DELAYED_CONF : UP
Is there any request to be used with Python Websocket API to retrieve such information?
Best Answer
-
Thank you for reaching out to us.
Yes, you can use the source directory request message.
{
"ID": 2,
"Domain": "Source",
"Key": {
"Filter": 3
}
}The response is:
[
{
"ID": 2,
"Type": "Refresh",
"Domain": "Source",
"Key": {
"Filter": 3
},
"State": {
"Stream": "Open",
"Data": "Ok"
},
"Map": {
"KeyType": "UInt",
"Entries": [
{
"Action": "Add",
"Key": 257,
"FilterList": {
"Entries": [
{
"ID": 1,
"Action": "Set",
"Elements": {
"Name": "ELEKTRON_DD",
"SupportsQoSRange": 0,
"Capabilities": {
"Type": "Array",
"Data": {
"Type": "UInt",
"Data": [
5,
6,
...
]
}
},
"QoS": {
"Type": "Array",
"Data": {
"Type": "Qos",
"Data": [
{
"Timeliness": "Realtime",
"Rate": "JitConflated"
}
]
}
},
...,
}
},
{
"ID": 2,
"Action": "Set",
"Elements": {
"ServiceState": 1,
"AcceptingRequests": 1
}
}
]
}
},
...
}
]2
Answers
-
Hello @Dustinn
Just want to add more information from @Jirapongse answer. You can check the service status from the ServiceState property.
- 0: Down
- 1: Up
Additionally, you can customize the filter parameter based on your preference:
{
"Key": {
"Filter": <Filter>
},
"ID": 2,
"Domain": "Source"
}The "Filter" value is a mask that provides different levels of details:
- 1 (SERVICE_INFO_FILTER) - info that identifies a service
- 2 (SERVICE_STATE_FILTER) - info about the current state of a service
- 4 (SERVICE_GROUP_FILTER) - item group status and item group merge info
- 8 (SERVICE_LOAD_FILTER) - info about the service workload
- 24 (SERVICE_DATA_FILTER) - info that should be applied to all items associated
- 32 (SERVICE_LINK_FILTER) - info about the upstream sources
which will provide more details in the response.
The filter that suggested Jirapongse is 3 which means SERVICE_INFO_FILTER (1) + SERVICE_STATE_FILTER (2).
1 -
Hello @Dustinn
This information is available in the "Source Directory Domain" section of the Refinitiv Domain Model Usage Guide document (RDM Usage Guide).
You can find the documents from the following links:
0
Categories
- All Categories
- 6 AHS
- 38 Alpha
- 161 App Studio
- 4 Block Chain
- 4 Bot Platform
- 16 Connected Risk APIs
- 47 Data Fusion
- 30 Data Model Discovery
- 608 Datastream
- 1.3K DSS
- 577 Eikon COM
- 4.9K Eikon Data APIs
- 7 Electronic Trading
- Generic FIX
- 7 Local Bank Node API
- Trading API
- 2.7K Elektron
- 1.3K EMA
- 236 ETA
- 519 WebSocket API
- 33 FX Venues
- 10 FX Market Data
- 1 FX Post Trade
- 1 FX Trading - Matching
- 12 FX Trading – RFQ Maker
- 5 Intelligent Tagging
- 2 Legal One
- 20 Messenger Bot
- 2 Messenger Side by Side
- 9 ONESOURCE
- 7 Indirect Tax
- 59 Open Calais
- 264 Open PermID
- 39 Entity Search
- 2 Org ID
- PAM
- PAM - Logging
- 8.4K Private Comments
- 6 Product Insight
- Project Tracking
- ProView
- ProView Internal
- 20 RDMS
- 1.4K Refinitiv Data Platform
- 367 Refinitiv Data Platform Libraries
- 3 Refinitiv Due Diligence
- LSEG Due Diligence Portal API
- 3 Refinitiv Due Dilligence Centre
- Rose's Space
- 1.1K Screening
- 18 Qual-ID API
- 13 Screening Deployed
- 23 Screening Online
- 10 World-Check Customer Risk Screener
- 990 World-Check One
- 44 World-Check One Zero Footprint
- 45 Side by Side Integration API
- Test Space
- 3 Thomson One Smart
- 1.2K TR Internal
- Global Hackathon 2015
- 2 Specialists Who Code
- 10 TR Knowledge Graph
- 150 Transactions
- 142 REDI API
- 1.7K TREP APIs
- 4 CAT
- 21 DACS Station
- 117 Open DACS
- 1.1K RFA
- 103 UPA
- 172 TREP Infrastructure
- 224 TRKD
- 886 TRTH
- 5 Velocity Analytics
- 5 Wealth Management Web Services
- 59 Workspace SDK
- 9 Element Framework
- 5 Grid
- 13 World-Check Data File
- Yield Book Analytics
- 46 中文论坛