Expand description
Current market-stream and legacy cluster WebSocket connections.
StandardWebSocketClient supports FMP’s current native WebSocket at
wss://socket.financialmodelingprep.com, with approved exchange, synthetic,
and delayed streams. StreamEntitlements explicitly records the approved
streams, while Subscription records the separately configured plan.
The legacy WebSocketClient supports stock, crypto, and forex clusters.
Legacy public docs omit successful login acknowledgments, so its config
requires an account-specific LoginConfirmation. Both connectors wait
for confirmed authentication before allowing subscriptions and report
active connection failures without silently reconnecting.
Structs§
- Authentication
Status - Required fields in the standard protocol’s nested login response.
- Close
Info - The remote peer’s completed close handshake.
- Control
Event - A validated JSON control envelope with its original, credential-redacted JSON.
- Heartbeat
- A standard stream heartbeat with the provider’s required timestamp.
- Market
Stream - A documented standard WebSocket stream, including its delayed variant.
- Quote
Update - Required fields of a top-of-book quote update.
- Standard
WebSocket Client - FMP’s current native WebSocket connector for approved market streams.
- Stream
Config - Explicit timeouts and retry settings for the standard stream protocol.
- Stream
Entitlements - Explicit stream grants confirmed in the account dashboard or with FMP.
- Stream
Quote - A standard stream quote with required symbol, price, and timestamp.
- Trade
Update - Required fields of a trade or trade-break update.
- WebSocket
Client - An authenticated connector to FMP’s legacy stock, crypto, or forex cluster.
- WebSocket
Config - Explicit timeouts and connection retry settings.
Enums§
- Market
Update - A strictly typed update using FMP’s documented T/Q/B discriminator.
- WebSocket
Cluster - The FMP market cluster to connect to.
- WebSocket
Error - A specific connection, configuration, server, or protocol failure.
- WebSocket
Event - An incoming application, pong, or close event.
Type Aliases§
- Login
Confirmation - Validates an account’s login acknowledgment.