cryptowatch_ex

v0.9.2

cryptowatch_ex v0.9.2 Cryptex

Documentation for Cryptex.

Link to this section Summary

Types

exchange()
market()

Functions

get_summary(exchange, market, opts \\ [])

Get summary for exchange and market

list_candles(exchange, market, params \\ [], opts \\ [])

List trades for exchange and market

list_summaries()

List all available exchange-market summaries

list_trades(exchange, market, params \\ [], opts \\ [])

List trades for exchange and market

Link to this section Types

Link to this type exchange() 
exchange() :: binary
Link to this type market() 
market() :: binary

Link to this section Functions

Link to this function get_summary(exchange, market, opts \\ []) 
get_summary(exchange, market, keyword) :: Cryptex.Types.Summary.t

Get summary for exchange and market

Link to this function list_candles(exchange, market, params \\ [], opts \\ []) 
list_candles(exchange, market, keyword, keyword) :: [Cryptex.Types.Candle.t]

List trades for exchange and market

Options

  • before - Only return candles opening before timestamp
  • after - Only return candles opening after timestamp
  • period - Fetch candles grouped by period in seconds
Link to this function list_summaries() 
list_summaries() :: [Cryptex.Types.Summary.t]

List all available exchange-market summaries

Link to this function list_trades(exchange, market, params \\ [], opts \\ []) 
list_trades(exchange, market, keyword, keyword) :: [Cryptex.Types.Trade.t]

List trades for exchange and market

Options

  • limit - Limit number of trades returned
  • since - Only return trades since timestamp