WebSocket: A WebSocket template

In eokodie/polygon: R Websocket & REST API client for Polygon

Description

This class manages WebSocket connections to polygon.io clusters.

Value

A WebSocket template.

Public Methods

close

close WebSocket connection.

connect_to_cluster

connect to a polygon WebSocket cluster.

authenticate

Authenticate connection.

subscribe

Subscribe to stream.

unsubscribe

Unsubscribe from a stream.

Methods

Public methods

• WebSocket$new()

• WebSocket$close()

• WebSocket$connect_to_cluster()

• WebSocket$authenticate()

• WebSocket$subscribe()

• WebSocket$unsubscribe()

• WebSocket$finalize()

---

Method new()

Usage

WebSocket$new(cluster)

---

Method close()

Usage

WebSocket$close()

---

Method connect_to_cluster()

Usage

WebSocket$connect_to_cluster(cluster)

---

Method authenticate()

Usage

WebSocket$authenticate()

---

Method subscribe()

Usage

WebSocket$subscribe(tickers)

---

Method unsubscribe()

Usage

WebSocket$unsubscribe(tickers)

---

Method finalize()

Usage

WebSocket$finalize()

eokodie/polygon documentation built on June 18, 2021, 10:19 p.m.