How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

LSEG WebSocket API

Standards-based WebSocket API for real-time pricing streaming using JSON message formats. Connects to Real-Time Distribution Systems and Real-Time Optimized cloud solutions for data consumption, contribution, and posting across Python, R, .NET, and other platforms.

This event API exposes 2 operations across 1 channel, and defines 27 schemas. It is described by AsyncAPI 2.6.0, at version 1.6.

The API connects through 2 servers: {host}:{port}/WebSocket (wss), api.refinitiv.com:443/WebSocket (wss).

2 operations 1 channels 27 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
1.6
Base URL
wss://api.refinitiv.com
License
Resource Areas
1

Channels & Operations 2

Across 1 channel, the API surfaces 2 operations. Each is listed below with its action, channel, parameters, and response codes.

Channels 2
SUB
/WebSocket
Messages received from the server.
receiveOmmMessage body
PUB
/WebSocket
Messages sent to the server.
sendOmmMessage body

Messages & Schemas 27

The contract defines 27 schemas that model the data carried by its messages. The most detailed are RefreshPayload (11 properties), UpdatePayload (10 properties), GenericMsgPayload (8 properties), PostPayload (8 properties). Each schema is shown below with its type and property counts.

LoginRequest
message
Initial Login Domain request authenticating the session.
LoginRefresh
message
Server response to a Login request indicating session state.
ItemRequest
message
Request to open or reissue a streaming or snapshot item.
Refresh
message
Full image of an item, sent on initial open or when re-syncing.
Update
message
Incremental update to a streaming item.
Status
message
Stream or data state change for an item (including stream close).
Close
message
Client-initiated close of a stream by its ID.
Ping
message
Liveness ping sent by the server.
Pong
message
Liveness pong sent by the client in response to a Ping.
Post
message
Off-stream or on-stream post used for contribution and inserts.
AckIn
message
Acknowledgement of a Post message, including any NAK code.
GenericMsgIn
message
Domain-defined message exchanged outside the request/refresh model.
GenericMsgOut
message
Domain-defined message sent by the client.
Key
object
OMM message Key identifying the item being requested.
6 properties
State
object
Stream and data state on Refresh / Status / Close messages.
4 properties
LoginRequestPayload
object
3 properties 3 required
LoginRefreshPayload
object
7 properties 3 required
ItemRequestPayload
object
8 properties 2 required
RefreshPayload
object
11 properties 2 required
UpdatePayload
object
10 properties 2 required
StatusPayload
object
5 properties 2 required
ClosePayload
object
3 properties 2 required
PingPayload
object
1 property 1 required
PongPayload
object
1 property 1 required
PostPayload
object
8 properties 2 required
AckPayload
object
6 properties 2 required
GenericMsgPayload
object
8 properties 2 required

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

refinitiv-eikon-asyncapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of LSEG WebSocket API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.