ContextQMD
Back to Ccxt

Hollaex

wiki/exchanges/hollaex.md

4.5.5224.6 KB
Original Source

<a name="hollaex" id="hollaex"></a>

hollaex{docsify-ignore}

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

<a name="fetchMarkets" id="fetchmarkets"></a>

fetchMarkets{docsify-ignore}

retrieves data on all markets for hollaex

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

See: https://apidocs.hollaex.com/#constants

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.fetchMarkets ([params])

<a name="fetchCurrencies" id="fetchcurrencies"></a>

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

Kind: instance method of <code>hollaex</code>
Returns: <code>object</code> - an associative dictionary of currencies

See: https://apidocs.hollaex.com/#constants

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.fetchCurrencies ([params])

<a name="fetchOrderBooks" id="fetchorderbooks"></a>

fetchOrderBooks{docsify-ignore}

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

Kind: instance method of <code>hollaex</code>
Returns: <code>object</code> - a dictionary of order book structures indexed by market symbol

See: https://apidocs.hollaex.com/#orderbooks

ParamTypeRequiredDescription
symbols<code>Array<string></code>, <code>undefined</code>Yesnot used by hollaex fetchOrderBooks ()
limit<code>int</code>Nonot used by hollaex fetchOrderBooks ()
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.fetchOrderBooks (symbols[, limit, params])

<a name="fetchOrderBook" id="fetchorderbook"></a>

fetchOrderBook{docsify-ignore}

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

Kind: instance method of <code>hollaex</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

See: https://apidocs.hollaex.com/#orderbook

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the order book for
limit<code>int</code>Nothe maximum amount of order book entries to return
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.fetchOrderBook (symbol[, limit, params])

<a name="fetchTicker" id="fetchticker"></a>

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

See: https://apidocs.hollaex.com/#ticker

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.fetchTicker (symbol[, params])

<a name="fetchTickers" id="fetchtickers"></a>

fetchTickers{docsify-ignore}

fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market

Kind: instance method of <code>hollaex</code>
Returns: <code>object</code> - a dictionary of ticker structures

See: https://apidocs.hollaex.com/#tickers

ParamTypeRequiredDescription
symbols<code>Array<string></code>, <code>undefined</code>Yesunified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.fetchTickers (symbols[, params])

<a name="fetchTrades" id="fetchtrades"></a>

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

See: https://apidocs.hollaex.com/#trades

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch trades for
since<code>int</code>Notimestamp in ms of the earliest trade to fetch
limit<code>int</code>Nothe maximum amount of trades to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.fetchTrades (symbol[, since, limit, params])

<a name="fetchTradingFees" id="fetchtradingfees"></a>

fetchTradingFees{docsify-ignore}

fetch the trading fees for multiple markets

Kind: instance method of <code>hollaex</code>
Returns: <code>object</code> - a dictionary of fee structures indexed by market symbols

See: https://apidocs.hollaex.com/#tiers

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.fetchTradingFees ([params])

<a name="fetchOHLCV" id="fetchohlcv"></a>

fetchOHLCV{docsify-ignore}

hollaex has large gaps between candles, so it's recommended to specify since

Kind: instance method of <code>hollaex</code>
Returns: <code>Array<Array<int>></code> - A list of candles ordered as timestamp, open, high, low, close, volume

See: https://apidocs.hollaex.com/#chart

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch OHLCV data for
timeframe<code>string</code>Yesthe length of time each candle represents
since<code>int</code>Notimestamp in ms of the earliest candle to fetch
limit<code>int</code>Nothe maximum amount of candles to fetch (max 500)
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Notimestamp in ms of the latest candle to fetch
javascript
hollaex.fetchOHLCV (symbol, timeframe[, since, limit, params])

<a name="fetchBalance" id="fetchbalance"></a>

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

See: https://apidocs.hollaex.com/#get-balance

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.fetchBalance ([params])

<a name="fetchOpenOrder" id="fetchopenorder"></a>

fetchOpenOrder{docsify-ignore}

fetch an open order by it's id

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

See: https://apidocs.hollaex.com/#get-order

ParamTypeRequiredDescription
id<code>string</code>Yesorder id
symbol<code>string</code>Yesnot used by hollaex fetchOpenOrder ()
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.fetchOpenOrder (id, symbol[, params])

<a name="fetchOpenOrders" id="fetchopenorders"></a>

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

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

See: https://apidocs.hollaex.com/#get-all-orders

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
since<code>int</code>Nothe earliest time in ms to fetch open orders for
limit<code>int</code>Nothe maximum number of open orders structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.fetchOpenOrders (symbol[, since, limit, params])

<a name="fetchClosedOrders" id="fetchclosedorders"></a>

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

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

See: https://apidocs.hollaex.com/#get-all-orders

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>Nothe earliest time in ms to fetch orders for
limit<code>int</code>Nothe maximum number of order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.fetchClosedOrders (symbol[, since, limit, params])

<a name="fetchOrder" id="fetchorder"></a>

fetchOrder{docsify-ignore}

fetches information on an order made by the user

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

See: https://apidocs.hollaex.com/#get-order

ParamTypeRequiredDescription
id<code>string</code>Yes
symbol<code>string</code>Yesunified symbol of the market the order was made in
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.fetchOrder (id, symbol[, params])

<a name="fetchOrders" id="fetchorders"></a>

fetchOrders{docsify-ignore}

fetches information on multiple orders made by the user

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

See: https://apidocs.hollaex.com/#get-all-orders

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>Nothe earliest time in ms to fetch orders for
limit<code>int</code>Nothe maximum number of order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.fetchOrders (symbol[, since, limit, params])

<a name="createOrder" id="createorder"></a>

createOrder{docsify-ignore}

create a trade order

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

See: https://apidocs.hollaex.com/#create-order

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to create an order in
type<code>string</code>Yes'market' or 'limit'
side<code>string</code>Yes'buy' or 'sell'
amount<code>float</code>Yeshow much of currency you want to trade in units of base currency
price<code>float</code>Nothe price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.triggerPrice<code>float</code>Nothe price at which a trigger order is triggered at
params.postOnly<code>bool</code>Noif true, the order will only be posted to the order book and not executed immediately
javascript
hollaex.createOrder (symbol, type, side, amount[, price, params])

<a name="cancelOrder" id="cancelorder"></a>

cancelOrder{docsify-ignore}

cancels an open order

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

See: https://apidocs.hollaex.com/#cancel-order

ParamTypeRequiredDescription
id<code>string</code>Yesorder id
symbol<code>string</code>Yesunified symbol of the market the order was made in
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.cancelOrder (id, symbol[, params])

<a name="cancelAllOrders" id="cancelallorders"></a>

cancelAllOrders{docsify-ignore}

cancel all open orders in a market

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

See: https://apidocs.hollaex.com/#cancel-all-orders

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market to cancel orders in
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.cancelAllOrders (symbol[, params])

<a name="fetchMyTrades" id="fetchmytrades"></a>

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

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

See: https://apidocs.hollaex.com/#get-trades

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
since<code>int</code>Nothe earliest time in ms to fetch trades for
limit<code>int</code>Nothe maximum number of trades structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.fetchMyTrades (symbol[, since, limit, params])

<a name="fetchDepositAddresses" id="fetchdepositaddresses"></a>

fetchDepositAddresses{docsify-ignore}

fetch deposit addresses for multiple currencies and chain types

Kind: instance method of <code>hollaex</code>
Returns: <code>object</code> - a list of address structures

See: https://apidocs.hollaex.com/#get-user

ParamTypeRequiredDescription
codes<code>Array<string></code>, <code>undefined</code>Yeslist of unified currency codes, default is undefined
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.fetchDepositAddresses (codes[, params])

<a name="fetchDeposits" id="fetchdeposits"></a>

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

Kind: instance method of <code>hollaex</code>
Returns: <code>Array<object></code> - a list of transaction structures

See: https://apidocs.hollaex.com/#get-deposits

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
since<code>int</code>Nothe earliest time in ms to fetch deposits for
limit<code>int</code>Nothe maximum number of deposits structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.fetchDeposits (code[, since, limit, params])

<a name="fetchWithdrawal" id="fetchwithdrawal"></a>

fetchWithdrawal{docsify-ignore}

fetch data on a currency withdrawal via the withdrawal id

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

See: https://apidocs.hollaex.com/#get-withdrawals

ParamTypeRequiredDescription
id<code>string</code>Yeswithdrawal id
code<code>string</code>Yesunified currency code of the currency withdrawn, default is undefined
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.fetchWithdrawal (id, code[, params])

<a name="fetchWithdrawals" id="fetchwithdrawals"></a>

fetchWithdrawals{docsify-ignore}

fetch all withdrawals made from an account

Kind: instance method of <code>hollaex</code>
Returns: <code>Array<object></code> - a list of transaction structures

See: https://apidocs.hollaex.com/#get-withdrawals

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
since<code>int</code>Nothe earliest time in ms to fetch withdrawals for
limit<code>int</code>Nothe maximum number of withdrawals structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.fetchWithdrawals (code[, since, limit, params])

<a name="withdraw" id="withdraw"></a>

withdraw{docsify-ignore}

make a withdrawal

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

See: https://apidocs.hollaex.com/#withdrawal

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
amount<code>float</code>Yesthe amount to withdraw
address<code>string</code>Yesthe address to withdraw to
tag<code>string</code>Yes
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.withdraw (code, amount, address, tag[, params])

<a name="fetchDepositWithdrawFees" id="fetchdepositwithdrawfees"></a>

fetchDepositWithdrawFees{docsify-ignore}

fetch deposit and withdraw fees

Kind: instance method of <code>hollaex</code>
Returns: <code>object</code> - a list of fee structures

See: https://apidocs.hollaex.com/#constants

ParamTypeRequiredDescription
codes<code>Array<string></code>, <code>undefined</code>Yeslist of unified currency codes
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.fetchDepositWithdrawFees (codes[, params])

<a name="watchOrderBook" id="watchorderbook"></a>

watchOrderBook{docsify-ignore}

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

Kind: instance method of <code>hollaex</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

See: https://apidocs.hollaex.com/#sending-receiving-messages

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the order book for
limit<code>int</code>Nothe maximum amount of order book entries to return
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.watchOrderBook (symbol[, limit, params])

<a name="watchTrades" id="watchtrades"></a>

watchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

See: https://apidocs.hollaex.com/#sending-receiving-messages

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch trades for
since<code>int</code>Notimestamp in ms of the earliest trade to fetch
limit<code>int</code>Nothe maximum amount of trades to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.watchTrades (symbol[, since, limit, params])

<a name="watchMyTrades" id="watchmytrades"></a>

watchMyTrades{docsify-ignore}

watches information on multiple trades made by the user

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

See: https://apidocs.hollaex.com/#sending-receiving-messages

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market trades were made in
since<code>int</code>Nothe earliest time in ms to fetch trades for
limit<code>int</code>Nothe maximum number of trade structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.watchMyTrades (symbol[, since, limit, params])

<a name="watchOrders" id="watchorders"></a>

watchOrders{docsify-ignore}

watches information on multiple orders made by the user

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

See: https://apidocs.hollaex.com/#sending-receiving-messages

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>Nothe earliest time in ms to fetch orders for
limit<code>int</code>Nothe maximum number of order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.watchOrders (symbol[, since, limit, params])

<a name="watchBalance" id="watchbalance"></a>

watchBalance{docsify-ignore}

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

Kind: instance method of <code>hollaex</code>
Returns: <code>object</code> - a balance structure

See: https://apidocs.hollaex.com/#sending-receiving-messages

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
hollaex.watchBalance ([params])