Bittrex v3.0.0-alpha.2 Bittrex.Markets View Source
Implements /markets endpoints.
Link to this section Summary
Functions
Retrieve information for a specific market
Retrieve candles for a specific market
List market summaries
Retrieve summary for a specific market
Retrieve the recent trades for a specific market
List markets
Retrieve the order book for a specific market
Link to this section Functions
Link to this function
get_market(client, market_name)
View Source
get_market(client, market_name)
View Source
get_market(
%Bittrex.Client{api_key: term(), api_secret: term(), sub_account_id: term()},
String.t()
) ::
StrawHat.Response.t(
%Bittrex.Market{
base_currency_name: term(),
base_currency_symbol: term(),
created_at: term(),
is_international: term(),
logo_url: term(),
min_trade_size: term(),
name: term(),
notice: term(),
quote_currency_name: term(),
quote_currency_symbol: term(),
status: term()
},
Bittrex.Client.error()
)
get_market( %Bittrex.Client{api_key: term(), api_secret: term(), sub_account_id: term()}, String.t() ) :: StrawHat.Response.t( %Bittrex.Market{ base_currency_name: term(), base_currency_symbol: term(), created_at: term(), is_international: term(), logo_url: term(), min_trade_size: term(), name: term(), notice: term(), quote_currency_name: term(), quote_currency_symbol: term(), status: term() }, Bittrex.Client.error() )
Retrieve information for a specific market.
Link to this function
get_market_candles(client, market_name, params \\ %{})
View Source
get_market_candles(client, market_name, params \\ %{})
View Source
get_market_candles(
%Bittrex.Client{api_key: term(), api_secret: term(), sub_account_id: term()},
String.t(),
%{candle_interval: String.t()}
) ::
StrawHat.Response.t(
%Bittrex.Candle{
base_volume: term(),
close: term(),
high: term(),
low: term(),
open: term(),
tick: term(),
volume: term()
},
Bittrex.Client.error()
)
get_market_candles( %Bittrex.Client{api_key: term(), api_secret: term(), sub_account_id: term()}, String.t(), %{candle_interval: String.t()} ) :: StrawHat.Response.t( %Bittrex.Candle{ base_volume: term(), close: term(), high: term(), low: term(), open: term(), tick: term(), volume: term() }, Bittrex.Client.error() )
Retrieve candles for a specific market.
Link to this function
get_market_summaries(client)
View Source
get_market_summaries(client)
View Source
get_market_summaries(%Bittrex.Client{
api_key: term(),
api_secret: term(),
sub_account_id: term()
}) ::
StrawHat.Response.t(
%Bittrex.MarketSummary{
ask: term(),
base_volume: term(),
bid: term(),
high: term(),
last: term(),
low: term(),
name: term(),
open_buy_orders: term(),
open_sell_orders: term(),
previous_day: term(),
updated_at: term(),
volume: term()
},
Bittrex.Client.error()
)
get_market_summaries(%Bittrex.Client{ api_key: term(), api_secret: term(), sub_account_id: term() }) :: StrawHat.Response.t( %Bittrex.MarketSummary{ ask: term(), base_volume: term(), bid: term(), high: term(), last: term(), low: term(), name: term(), open_buy_orders: term(), open_sell_orders: term(), previous_day: term(), updated_at: term(), volume: term() }, Bittrex.Client.error() )
List market summaries.
Link to this function
get_market_summary(client, market_name)
View Source
get_market_summary(client, market_name)
View Source
get_market_summary(
%Bittrex.Client{api_key: term(), api_secret: term(), sub_account_id: term()},
String.t()
) ::
StrawHat.Response.t(
%Bittrex.MarketSummary{
ask: term(),
base_volume: term(),
bid: term(),
high: term(),
last: term(),
low: term(),
name: term(),
open_buy_orders: term(),
open_sell_orders: term(),
previous_day: term(),
updated_at: term(),
volume: term()
},
Bittrex.Client.error()
)
get_market_summary( %Bittrex.Client{api_key: term(), api_secret: term(), sub_account_id: term()}, String.t() ) :: StrawHat.Response.t( %Bittrex.MarketSummary{ ask: term(), base_volume: term(), bid: term(), high: term(), last: term(), low: term(), name: term(), open_buy_orders: term(), open_sell_orders: term(), previous_day: term(), updated_at: term(), volume: term() }, Bittrex.Client.error() )
Retrieve summary for a specific market.
Link to this function
get_market_trades(client, market_name)
View Source
get_market_trades(client, market_name)
View Source
get_market_trades(
%Bittrex.Client{api_key: term(), api_secret: term(), sub_account_id: term()},
String.t()
) ::
StrawHat.Response.t(
%Bittrex.Trade{executed_at: term(), quantity: term(), rate: term()},
Bittrex.Client.error()
)
get_market_trades( %Bittrex.Client{api_key: term(), api_secret: term(), sub_account_id: term()}, String.t() ) :: StrawHat.Response.t( %Bittrex.Trade{executed_at: term(), quantity: term(), rate: term()}, Bittrex.Client.error() )
Retrieve the recent trades for a specific market.
Link to this function
get_markets(client, params \\ %{})
View Source
get_markets(client, params \\ %{})
View Source
get_markets(
%Bittrex.Client{api_key: term(), api_secret: term(), sub_account_id: term()},
%{}
) ::
StrawHat.Response.t(
[
%Bittrex.Market{
base_currency_name: term(),
base_currency_symbol: term(),
created_at: term(),
is_international: term(),
logo_url: term(),
min_trade_size: term(),
name: term(),
notice: term(),
quote_currency_name: term(),
quote_currency_symbol: term(),
status: term()
}
],
Bittrex.Client.error()
)
get_markets( %Bittrex.Client{api_key: term(), api_secret: term(), sub_account_id: term()}, %{} ) :: StrawHat.Response.t( [ %Bittrex.Market{ base_currency_name: term(), base_currency_symbol: term(), created_at: term(), is_international: term(), logo_url: term(), min_trade_size: term(), name: term(), notice: term(), quote_currency_name: term(), quote_currency_symbol: term(), status: term() } ], Bittrex.Client.error() )
List markets.
Link to this function
get_order_book(client, market_name, params \\ %{})
View Source
get_order_book(client, market_name, params \\ %{})
View Source
get_order_book(
%Bittrex.Client{api_key: term(), api_secret: term(), sub_account_id: term()},
String.t(),
%{depth: integer()}
) ::
StrawHat.Response.t(
%Bittrex.OrderBook{ask: term(), bid: term()},
Bittrex.Client.error()
)
get_order_book( %Bittrex.Client{api_key: term(), api_secret: term(), sub_account_id: term()}, String.t(), %{depth: integer()} ) :: StrawHat.Response.t( %Bittrex.OrderBook{ask: term(), bid: term()}, Bittrex.Client.error() )
Retrieve the order book for a specific market.