Zaif - Ccxt — ContextQMD

zaif{docsify-ignore}

Kind: global class
Extends: <code>Exchange</code>

fetchMarkets
fetchBalance
fetchOrderBook
fetchTicker
fetchTrades
createOrder
cancelOrder
fetchOpenOrders
fetchClosedOrders
withdraw

fetchMarkets{docsify-ignore}

retrieves data on all markets for zaif

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

See: https://zaif-api-document.readthedocs.io/ja/latest/PublicAPI.html#id12

Param	Type	Required	Description
params	<code>object</code>	No	extra parameters specific to the exchange API endpoint

javascript

zaif.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 <code>zaif</code>
Returns: <code>object</code> - a balance structure

See: https://zaif-api-document.readthedocs.io/ja/latest/TradingAPI.html#id10

Param	Type	Required	Description
params	<code>object</code>	No	extra parameters specific to the exchange API endpoint

javascript

zaif.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 <code>zaif</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

See: https://zaif-api-document.readthedocs.io/ja/latest/PublicAPI.html#id34

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

javascript

zaif.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 <code>zaif</code>
Returns: <code>object</code> - a ticker structure

See: https://zaif-api-document.readthedocs.io/ja/latest/PublicAPI.html#id22

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

javascript

zaif.fetchTicker (symbol[, params])

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of <code>zaif</code>
Returns: <code>Array<Trade></code> - a list of trade structures

See: https://zaif-api-document.readthedocs.io/ja/latest/PublicAPI.html#id28

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

javascript

zaif.fetchTrades (symbol[, since, limit, params])

createOrder{docsify-ignore}

create a trade order

Kind: instance method of <code>zaif</code>
Returns: <code>object</code> - an order structure

See: https://zaif-api-document.readthedocs.io/ja/latest/MarginTradingAPI.html#id23

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

javascript

zaif.createOrder (symbol, type, side, amount[, price, params])

cancelOrder{docsify-ignore}

cancels an open order

Kind: instance method of <code>zaif</code>
Returns: <code>object</code> - An order structure

See: https://zaif-api-document.readthedocs.io/ja/latest/TradingAPI.html#id37

Param	Type	Required	Description
id	<code>string</code>	Yes	order id
symbol	<code>string</code>	Yes	not used by zaif cancelOrder ()
params	<code>object</code>	No	extra parameters specific to the exchange API endpoint

javascript

zaif.cancelOrder (id, symbol[, params])

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

Kind: instance method of <code>zaif</code>
Returns: <code>Array<Order></code> - a list of order structures

See: https://zaif-api-document.readthedocs.io/ja/latest/MarginTradingAPI.html#id28

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

javascript

zaif.fetchOpenOrders (symbol[, since, limit, params])

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

Kind: instance method of <code>zaif</code>
Returns: <code>Array<Order></code> - a list of order structures

See: https://zaif-api-document.readthedocs.io/ja/latest/TradingAPI.html#id24

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

javascript

zaif.fetchClosedOrders (symbol[, since, limit, params])

withdraw{docsify-ignore}

make a withdrawal

Kind: instance method of <code>zaif</code>
Returns: <code>object</code> - a transaction structure

See: https://zaif-api-document.readthedocs.io/ja/latest/TradingAPI.html#id41

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

javascript

zaif.withdraw (code, amount, address, tag[, params])