Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Refinitiv Real-Time WebSocket API

Low-latency streaming API for real-time market data using WebSocket connections. It supports the Open Message Model (OMM) and allows applications to connect directly to Refinitiv Real-Time distribution systems or the LSEG Data Platform for streaming data.

This event API exposes 8 operations across 4 channels, and defines 11 schemas. It is described by AsyncAPI 2.6.0, at version 1.0.0.

The API connects through 2 servers: wss://api.refinitiv.com/streaming/pricing/v1/ (wss), wss://{ads-hostname}:{port}/WebSocket (wss).

8 operations 4 channels 11 schemas

Metadata

The identity and technical contract details declared by the specification.

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

Channels & Operations 8

Across 4 channels, the API surfaces 8 operations. Each is listed below with its action, channel, parameters, and response codes.

Channels 8
SUB
login
Receive login response
receiveLoginResponse body
PUB
login
Send login request
sendLoginRequest body
SUB
pricingStream
Receive market price updates
receiveMarketPriceData body
PUB
pricingStream
Request market price streaming data
sendMarketPriceRequest body
SUB
marketDepth
Receive market depth updates
receiveMarketByPriceData body
PUB
marketDepth
Request market depth data
sendMarketByPriceRequest body
SUB
ping
Receive ping heartbeat
receivePing body
PUB
ping
Send pong heartbeat response
sendPong body

Messages & Schemas 11

The contract defines 11 schemas that model the data carried by its messages. Each schema is shown below with its type and property counts.

LoginRequest
message
Initial authentication message sent to establish a streaming session.
LoginResponse
message
Response to the login request indicating session status and entitlements.
MarketPriceRequest
message
Request to subscribe to real-time pricing data for instruments.
MarketPriceRefresh
message
Initial snapshot of pricing data for a subscribed instrument.
MarketPriceUpdate
message
Incremental pricing update for a subscribed instrument containing only changed fields.
MarketByPriceRequest
message
Request to subscribe to Level 2 market depth data.
MarketByPriceRefresh
message
Initial snapshot of the full order book for a subscribed instrument.
MarketByPriceUpdate
message
Incremental update to the order book for a subscribed instrument.
StatusMessage
message
Status message indicating stream state changes such as errors, closures, or redirects.
PingMessage
message
Server heartbeat message that must be responded to with a pong.
PongMessage
message
Client heartbeat response to a server ping message.

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

refinitiv-real-time-websocket-asyncapi.yml Raw ↑