bitflyer

bitflyer{docsify-ignore}

Kind: global class
Extends: Exchange

• fetchMarkets
• fetchBalance
• fetchOrderBook
• fetchTicker
• fetchTrades
• fetchTradingFee
• createOrder
• cancelOrder
• fetchOrders
• fetchOpenOrders
• fetchClosedOrders
• fetchOrder
• fetchMyTrades
• fetchPositions
• withdraw
• fetchDeposits
• fetchWithdrawals
• fetchFundingRate

fetchMarkets{docsify-ignore}

retrieves data on all markets for bitflyer

Kind: instance method of bitflyer
Returns: Array<object> - an array of objects representing market data

See: https://lightning.bitflyer.com/docs?lang=en#market-list

Param	Type	Required	Description
params	object	No	extra parameters specific to the exchange API endpoint

bitflyer.fetchMarkets (params?)

fetchBalance{docsify-ignore}

query for balance and get the amount of funds available for trading or funds locked in orders

Kind: instance method of bitflyer
Returns: object - a balance structure

See: https://lightning.bitflyer.com/docs?lang=en#get-account-asset-balance

Param	Type	Required	Description
params	object	No	extra parameters specific to the exchange API endpoint

bitflyer.fetchBalance (params?)

fetchOrderBook{docsify-ignore}

fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data

Kind: instance method of bitflyer
Returns: object - A dictionary of order book structures indexed by market symbols

See: https://lightning.bitflyer.com/docs?lang=en#order-book

Param	Type	Required	Description
symbol	string	Yes	unified symbol of the market to fetch the order book for
limit	int	No	the maximum amount of order book entries to return
params	object	No	extra parameters specific to the exchange API endpoint

bitflyer.fetchOrderBook (symbol, limit?, params?)

fetchTicker{docsify-ignore}

fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market

Kind: instance method of bitflyer
Returns: object - a ticker structure

See: https://lightning.bitflyer.com/docs?lang=en#ticker

Param	Type	Required	Description
symbol	string	Yes	unified symbol of the market to fetch the ticker for
params	object	No	extra parameters specific to the exchange API endpoint

bitflyer.fetchTicker (symbol, params?)

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of bitflyer
Returns: Array<Trade> - a list of trade structures

See: https://lightning.bitflyer.com/docs?lang=en#list-executions

Param	Type	Required	Description
symbol	string	Yes	unified symbol of the market to fetch trades for
since	int	No	timestamp in ms of the earliest trade to fetch
limit	int	No	the maximum amount of trades to fetch
params	object	No	extra parameters specific to the exchange API endpoint

bitflyer.fetchTrades (symbol, since?, limit?, params?)

fetchTradingFee{docsify-ignore}

fetch the trading fees for a market

Kind: instance method of bitflyer
Returns: object - a fee structure

See: https://lightning.bitflyer.com/docs?lang=en#get-trading-commission

Param	Type	Required	Description
symbol	string	Yes	unified market symbol
params	object	No	extra parameters specific to the exchange API endpoint

bitflyer.fetchTradingFee (symbol, params?)

createOrder{docsify-ignore}

create a trade order

Kind: instance method of bitflyer
Returns: object - an order structure

See: https://lightning.bitflyer.com/docs?lang=en#send-a-new-order

Param	Type	Required	Description
symbol	string	Yes	unified symbol of the market to create an order in
type	string	Yes	'market' or 'limit'
side	string	Yes	'buy' or 'sell'
amount	float	Yes	how much of currency you want to trade in units of base currency
price	float	No	the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
params	object	No	extra parameters specific to the exchange API endpoint

bitflyer.createOrder (symbol, type, side, amount, price?, params?)

cancelOrder{docsify-ignore}

cancels an open order

Kind: instance method of bitflyer
Returns: object - An order structure

See: https://lightning.bitflyer.com/docs?lang=en#cancel-order

Param	Type	Required	Description
id	string	Yes	order id
symbol	string	Yes	unified symbol of the market the order was made in
params	object	No	extra parameters specific to the exchange API endpoint

bitflyer.cancelOrder (id, symbol, params?)

fetchOrders{docsify-ignore}

fetches information on multiple orders made by the user

Kind: instance method of bitflyer
Returns: Array<Order> - a list of order structures

See: https://lightning.bitflyer.com/docs?lang=en#list-orders

Param	Type	Required	Description
symbol	string	Yes	unified market symbol of the market orders were made in
since	int	No	the earliest time in ms to fetch orders for
limit	int	No	the maximum number of order structures to retrieve
params	object	No	extra parameters specific to the exchange API endpoint

bitflyer.fetchOrders (symbol, since?, limit?, params?)

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

Kind: instance method of bitflyer
Returns: Array<Order> - a list of order structures

See: https://lightning.bitflyer.com/docs?lang=en#list-orders

Param	Type	Required	Description
symbol	string	Yes	unified market symbol
since	int	No	the earliest time in ms to fetch open orders for
limit	int	No	the maximum number of open orders structures to retrieve
params	object	No	extra parameters specific to the exchange API endpoint

bitflyer.fetchOpenOrders (symbol, since?, limit?, params?)

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

Kind: instance method of bitflyer
Returns: Array<Order> - a list of order structures

See: https://lightning.bitflyer.com/docs?lang=en#list-orders

Param	Type	Required	Description
symbol	string	Yes	unified market symbol of the market orders were made in
since	int	No	the earliest time in ms to fetch orders for
limit	int	No	the maximum number of order structures to retrieve
params	object	No	extra parameters specific to the exchange API endpoint

bitflyer.fetchClosedOrders (symbol, since?, limit?, params?)

fetchOrder{docsify-ignore}

fetches information on an order made by the user

Kind: instance method of bitflyer
Returns: object - An order structure

See: https://lightning.bitflyer.com/docs?lang=en#list-orders

Param	Type	Required	Description
id	string	Yes	the order id
symbol	string	Yes	unified symbol of the market the order was made in
params	object	No	extra parameters specific to the exchange API endpoint

bitflyer.fetchOrder (id, symbol, params?)

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

Kind: instance method of bitflyer
Returns: Array<Trade> - a list of trade structures

See: https://lightning.bitflyer.com/docs?lang=en#list-executions

Param	Type	Required	Description
symbol	string	Yes	unified market symbol
since	int	No	the earliest time in ms to fetch trades for
limit	int	No	the maximum number of trades structures to retrieve
params	object	No	extra parameters specific to the exchange API endpoint

bitflyer.fetchMyTrades (symbol, since?, limit?, params?)

fetchPositions{docsify-ignore}

fetch all open positions

Kind: instance method of bitflyer
Returns: Array<object> - a list of position structure

See: https://lightning.bitflyer.com/docs?lang=en#get-open-interest-summary

Param	Type	Required	Description
symbols	Array<string>	Yes	list of unified market symbols
params	object	No	extra parameters specific to the exchange API endpoint

bitflyer.fetchPositions (symbols, params?)

withdraw{docsify-ignore}

make a withdrawal

Kind: instance method of bitflyer
Returns: object - a transaction structure

See: https://lightning.bitflyer.com/docs?lang=en#withdrawing-funds

Param	Type	Required	Description
code	string	Yes	unified currency code
amount	float	Yes	the amount to withdraw
address	string	Yes	the address to withdraw to
tag	string	Yes
params	object	No	extra parameters specific to the exchange API endpoint

bitflyer.withdraw (code, amount, address, tag, params?)

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

Kind: instance method of bitflyer
Returns: Array<object> - a list of transaction structures

See: https://lightning.bitflyer.com/docs?lang=en#get-crypto-assets-deposit-history

Param	Type	Required	Description
code	string	Yes	unified currency code
since	int	No	the earliest time in ms to fetch deposits for
limit	int	No	the maximum number of deposits structures to retrieve
params	object	No	extra parameters specific to the exchange API endpoint

bitflyer.fetchDeposits (code, since?, limit?, params?)

fetchWithdrawals{docsify-ignore}

fetch all withdrawals made from an account

Kind: instance method of bitflyer
Returns: Array<object> - a list of transaction structures

See: https://lightning.bitflyer.com/docs?lang=en#get-crypto-assets-transaction-history

Param	Type	Required	Description
code	string	Yes	unified currency code
since	int	No	the earliest time in ms to fetch withdrawals for
limit	int	No	the maximum number of withdrawals structures to retrieve
params	object	No	extra parameters specific to the exchange API endpoint

bitflyer.fetchWithdrawals (code, since?, limit?, params?)

fetchFundingRate{docsify-ignore}

fetch the current funding rate

Kind: instance method of bitflyer
Returns: object - a funding rate structure

See: https://lightning.bitflyer.com/docs#funding-rate

Param	Type	Required	Description
symbol	string	Yes	unified market symbol
params	object	No	extra parameters specific to the exchange API endpoint

bitflyer.fetchFundingRate (symbol, params?)