View Source ExTwelveData.RealTimePrices (ExTwelveData v0.4.0)

WebSocket client to get real-time prices from Twelve Data.

Summary

option()

options()

symbols_list()

Symbols passed to subscribe/unsubscribe.

reset(client)

Reset the subscription to all price updates.

start_link(opts)

Specify a list of symbols you're interested to.

Send a list of symbols that you're no longer interested to.

@type option() ::
  WebSockex.option()
  | {:api_key, binary()}
  | {:handler, ExTwelveData.RealTimePrices.Handler}

@type options() :: [option()]

@type symbols_list() :: String.t() | [ExTwelveData.Symbol.t()]

Symbols passed to subscribe/unsubscribe.

It can either be an array of objects (extended format), or a comma-delimited string with multiple symbols.

@spec reset(pid()) :: {:error, any()} | {:ok}

Reset the subscription to all price updates.

@spec start_link(options()) :: {:error, any()} | {:ok, pid()}

@spec unsubscribe(pid(), symbols_list()) :: {:error, any()} | {:ok}

Send a list of symbols that you're no longer interested to.

Twelve Data will stop sending updates.