bitflyex

v0.1.0

bitflyex v0.1.0 BitFlyex

bitFlyer Lightning API library.

Link to this section Summary

Functions

balance()

List account balance

board(product_code \\ nil)

Get board (List bids & asks)

executions(product_code \\ nil)

List order executions

get_addresses()

List bitcoin addresses

get_bank_accounts()

Get bank accounts

get_coin_ins()

Get bitcoin ins

get_coin_outs()

Get bitcoin outs

get_collateral()

Get collateral

get_collateral_accounts()

Get collateral acounts

get_deposits()

List deposits

get_permisions()

List permisions

get_withdrawals()

List widthdrawals

markets()

List market products

order_market(product_code, signal, position_size)

Order market #

## Examples

iex> BitFlyex.order_market( “BTC_JPY”, 1, 0.001 )

%{“child_order_acceptance_id” => “JRF20180108-125220-041773”}

iex> BitFlyex.order_market( “BTC_JPY”, -1, 0.001 )

%{“child_order_acceptance_id” => “JRF20180108-125324-357807”}

ticker(product_code \\ nil)

Get ticker

timestamp()

Get timestamp (this test for balance() test. Don’t remove)

withdraw(currency_code, bank_account_id, amount, code)

Withdraw to bank #

## Examples

iex> BitFlyex.withdraw( “JPY”, 139xxxxxx, 100000, “87xxx6” )

%{“message_id” => “2bxxxxx-exxx-4xxx-bxxx-c8xxxxxxxx”}

Link to this section Functions

Link to this function balance()

List account balance

Examples 

iex> BitFlyex.balance |> is_list
true
Link to this function board(product_code \\ nil)

Get board (List bids & asks)

Examples 

iex> BitFlyex.board |> Map.keys
["asks", "bids", "mid_price"]
Link to this function executions(product_code \\ nil)

List order executions

Examples 

iex> BitFlyex.executions |> List.first |> Map.keys
["buy_child_order_acceptance_id", "exec_date", "id", "price", "sell_child_order_acceptance_id", "side", "size"]
Link to this function get_addresses()

List bitcoin addresses

Examples 

iex> BitFlyex.get_addresses |> List.first |> Map.keys
["address", "currency_code", "type"]
iex> BitFlyex.get_addresses |> Enum.map( fn %{ "currency_code" => currency_code } -> currency_code end )
["BTC", "BCH"]
Link to this function get_bank_accounts()

Get bank accounts

Examples 

iex> BitFlyex.get_bank_accounts |> List.first |> Map.keys
["account_name", "account_number", "account_type", "bank_name", "branch_name", "id", "is_verified"]
Link to this function get_coin_ins()

Get bitcoin ins

Examples 

iex> BitFlyex.get_coin_ins
[]
Link to this function get_coin_outs()

Get bitcoin outs

Examples 

iex> BitFlyex.get_coin_outs
[]
Link to this function get_collateral()

Get collateral

Examples 

iex> BitFlyex.get_collateral |> Map.keys
["collateral", "keep_rate", "open_position_pnl", "require_collateral"]
Link to this function get_collateral_accounts()

Get collateral acounts

Examples 

iex> BitFlyex.get_collateral_accounts
[]
Link to this function get_deposits()

List deposits

Examples 

iex> BitFlyex.get_deposits |> is_list
true
Link to this function get_permisions()

List permisions

Examples 

iex> BitFlyex.get_permisions |> is_list
true
Link to this function get_withdrawals()

List widthdrawals

Examples 

iex> BitFlyex.get_withdrawals |> is_list
true
Link to this function markets()

List market products

Examples 

iex> BitFlyex.markets |> Enum.map( fn %{ "product_code" => product_code } -> product_code end )
["BTC_JPY", "FX_BTC_JPY", "ETH_BTC", "BCH_BTC", "BTCJPY12JAN2018", "BTCJPY19JAN2018"]
Link to this function order_market(product_code, signal, position_size)

Order market #

## Examples

iex> BitFlyex.order_market( “BTC_JPY”, 1, 0.001 )

%{“child_order_acceptance_id” => “JRF20180108-125220-041773”}

iex> BitFlyex.order_market( “BTC_JPY”, -1, 0.001 )

%{“child_order_acceptance_id” => “JRF20180108-125324-357807”}

Link to this function ticker(product_code \\ nil)

Get ticker

Examples 

iex> BitFlyex.ticker|> Map.keys
["best_ask", "best_ask_size", "best_bid", "best_bid_size", "ltp","product_code", 
 "tick_id", "timestamp", "total_ask_depth", "total_bid_depth", "volume", "volume_by_product"]
Link to this function timestamp()

Get timestamp (this test for balance() test. Don’t remove)

Examples 

iex> BitFlyex.timestamp |> String.length
22
Link to this function withdraw(currency_code, bank_account_id, amount, code)

Withdraw to bank #

## Examples

iex> BitFlyex.withdraw( “JPY”, 139xxxxxx, 100000, “87xxx6” )

%{“message_id” => “2bxxxxx-exxx-4xxx-bxxx-c8xxxxxxxx”}