AsyncWebSocket

AsyncWebSocket

Asynchronous WebSocket client for real-time Yahoo Finance price streaming. Identical API surface to WebSocket. Add async and await keywords to use.

from pyahoo import AsyncWebSocket
# or
from pyahoo.async_websocket import AsyncWebSocket

Constructor

AsyncWebSocket(
    *,
    url: str = STREAMER_URL,
    version: int = STREAMER_VERSION,
    reconnect: bool = True,
    reconnect_base: float = STREAMER_RECONNECT_BASE,
    reconnect_max: float = STREAMER_RECONNECT_MAX,
    max_reconnect_attempts: int | None = None,
    proxy: str | None = None,
    queue_size: int = 10_000
)

Parameters

• url (str, optional): WebSocket URL, by default "wss://streamer.finance.yahoo.com/".
• version (int, optional): API version parameter, by default 2.
• reconnect (bool, optional): Whether to auto-reconnect on disconnection, by default True.
• reconnect_base (float, optional): Base delay for exponential backoff (seconds), by default 1.0.
• reconnect_max (float, optional): Maximum reconnect delay (seconds), by default 60.0.
• max_reconnect_attempts (int, optional): Maximum reconnection attempts, or None for unlimited.
• proxy (str, optional): Proxy URL.
• queue_size (int, optional): Maximum number of ticks buffered for iteration, by default 10_000.