Skip to content

hollaex

github-actions[bot] edited this page Apr 6, 2026 · 1 revision

hollaex{docsify-ignore}

Kind: global class
Extends: Exchange

fetchMarkets{docsify-ignore}

retrieves data on all markets for hollaex

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

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

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint
hollaex.fetchMarkets ([params])

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

Kind: instance method of hollaex
Returns: object - an associative dictionary of currencies

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

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint
hollaex.fetchCurrencies ([params])

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 hollaex
Returns: object - a dictionary of order book structures indexed by market symbol

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

Param Type Required Description
symbols Array<string>, undefined Yes not used by hollaex fetchOrderBooks ()
limit int No not used by hollaex fetchOrderBooks ()
params object No extra parameters specific to the exchange API endpoint
hollaex.fetchOrderBooks (symbols[, limit, params])

fetchOrderBook{docsify-ignore}

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

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

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

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

See: https://apidocs.hollaex.com/#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
hollaex.fetchTicker (symbol[, params])

fetchTickers{docsify-ignore}

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

Kind: instance method of hollaex
Returns: object - a dictionary of ticker structures

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

Param Type Required Description
symbols Array<string>, undefined Yes unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
params object No extra parameters specific to the exchange API endpoint
hollaex.fetchTickers (symbols[, params])

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

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

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
hollaex.fetchTrades (symbol[, since, limit, params])

fetchTradingFees{docsify-ignore}

fetch the trading fees for multiple markets

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

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

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint
hollaex.fetchTradingFees ([params])

fetchOHLCV{docsify-ignore}

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

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

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

Param Type Required Description
symbol string Yes unified symbol of the market to fetch OHLCV data for
timeframe string Yes the length of time each candle represents
since int No timestamp in ms of the earliest candle to fetch
limit int No the maximum amount of candles to fetch (max 500)
params object No extra parameters specific to the exchange API endpoint
params.until int No timestamp in ms of the latest candle to fetch
hollaex.fetchOHLCV (symbol, timeframe[, since, limit, 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 hollaex
Returns: object - a balance structure

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

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint
hollaex.fetchBalance ([params])

fetchOpenOrder{docsify-ignore}

fetch an open order by it's id

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

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

Param Type Required Description
id string Yes order id
symbol string Yes not used by hollaex fetchOpenOrder ()
params object No extra parameters specific to the exchange API endpoint
hollaex.fetchOpenOrder (id, symbol[, params])

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

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

See: https://apidocs.hollaex.com/#get-all-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
hollaex.fetchOpenOrders (symbol[, since, limit, params])

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

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

See: https://apidocs.hollaex.com/#get-all-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
hollaex.fetchClosedOrders (symbol[, since, limit, params])

fetchOrder{docsify-ignore}

fetches information on an order made by the user

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

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

Param Type Required Description
id string Yes
symbol string Yes unified symbol of the market the order was made in
params object No extra parameters specific to the exchange API endpoint
hollaex.fetchOrder (id, symbol[, params])

fetchOrders{docsify-ignore}

fetches information on multiple orders made by the user

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

See: https://apidocs.hollaex.com/#get-all-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
hollaex.fetchOrders (symbol[, since, limit, params])

createOrder{docsify-ignore}

create a trade order

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

See: https://apidocs.hollaex.com/#create-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
params.triggerPrice float No the price at which a trigger order is triggered at
params.postOnly bool No if true, the order will only be posted to the order book and not executed immediately
hollaex.createOrder (symbol, type, side, amount[, price, params])

cancelOrder{docsify-ignore}

cancels an open order

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

See: https://apidocs.hollaex.com/#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
hollaex.cancelOrder (id, symbol[, params])

cancelAllOrders{docsify-ignore}

cancel all open orders in a market

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

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

Param Type Required Description
symbol string Yes unified market symbol of the market to cancel orders in
params object No extra parameters specific to the exchange API endpoint
hollaex.cancelAllOrders (symbol[, params])

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

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

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

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
hollaex.fetchMyTrades (symbol[, since, limit, params])

fetchDepositAddresses{docsify-ignore}

fetch deposit addresses for multiple currencies and chain types

Kind: instance method of hollaex
Returns: object - a list of address structures

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

Param Type Required Description
codes Array<string>, undefined Yes list of unified currency codes, default is undefined
params object No extra parameters specific to the exchange API endpoint
hollaex.fetchDepositAddresses (codes[, params])

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

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

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

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
hollaex.fetchDeposits (code[, since, limit, params])

fetchWithdrawal{docsify-ignore}

fetch data on a currency withdrawal via the withdrawal id

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

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

Param Type Required Description
id string Yes withdrawal id
code string Yes unified currency code of the currency withdrawn, default is undefined
params object No extra parameters specific to the exchange API endpoint
hollaex.fetchWithdrawal (id, code[, params])

fetchWithdrawals{docsify-ignore}

fetch all withdrawals made from an account

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

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

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
hollaex.fetchWithdrawals (code[, since, limit, params])

withdraw{docsify-ignore}

make a withdrawal

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

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

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
hollaex.withdraw (code, amount, address, tag[, params])

fetchDepositWithdrawFees{docsify-ignore}

fetch deposit and withdraw fees

Kind: instance method of hollaex
Returns: object - a list of fee structures

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

Param Type Required Description
codes Array<string>, undefined Yes list of unified currency codes
params object No extra parameters specific to the exchange API endpoint
hollaex.fetchDepositWithdrawFees (codes[, params])

watchOrderBook{docsify-ignore}

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

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

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

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
hollaex.watchOrderBook (symbol[, limit, params])

watchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

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

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
hollaex.watchTrades (symbol[, since, limit, params])

watchMyTrades{docsify-ignore}

watches information on multiple trades made by the user

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

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

Param Type Required Description
symbol string Yes unified market symbol of the market trades were made in
since int No the earliest time in ms to fetch trades for
limit int No the maximum number of trade structures to retrieve
params object No extra parameters specific to the exchange API endpoint
hollaex.watchMyTrades (symbol[, since, limit, params])

watchOrders{docsify-ignore}

watches information on multiple orders made by the user

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

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

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
hollaex.watchOrders (symbol[, since, limit, params])

watchBalance{docsify-ignore}

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

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

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

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint
hollaex.watchBalance ([params])

Clone this wiki locally