ritmex-bot/docs/ccxt/wiki/exchanges/zaif.md

zaif{docsify-ignore}

Kind: global class
Extends: Exchange

• fetchMarkets
• fetchBalance
• fetchOrderBook
• fetchTicker
• fetchTrades
• createOrder
• cancelOrder
• fetchOpenOrders
• fetchClosedOrders
• withdraw

fetchMarkets{docsify-ignore}

retrieves data on all markets for zaif

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

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

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

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

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

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

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 zaif
Returns: object - 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	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

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

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

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

zaif.fetchTicker (symbol[, params])

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

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

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

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

createOrder{docsify-ignore}

create a trade order

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

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

Param	Type	Required	Description
symbol	string	Yes	unified symbol of the market to create an order in
type	string	Yes	must be '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

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

cancelOrder{docsify-ignore}

cancels an open order

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

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

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

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

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

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

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

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

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

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

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

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

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

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

withdraw{docsify-ignore}

make a withdrawal

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

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

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

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