HollaEx
⚙️ Dashboard
Search
⌃K
Links

Functions

A list of the functions, with their parameters and description of their purpose.

Available Functions:

Command
Parameters
Description
init
  • opts: Object with additional params
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Initialize your Kit for HollaEx Network. Must have passed activation_code in constructor
getTicker
  • symbol: HollaEx trading symbol e.g. xht-usdt
  • opts: Object with additional params
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Last, high, low, open and close price and volume within the last 24 hours
getTickers
  • opts: Object with additional params
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Last, high, low, open and close price and volume within the last 24 hours for all symbols
getOrderbook
  • symbol: HollaEx trading symbol e.g. xht-usdt
  • opts: Object with additional params
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Orderbook containing list of bids and asks
getOrderbooks
  • opts: Object with additional params
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Orderbook containing list of bids and asks for all symbols
getPublicTrades
  • opts: Object with additional params
  • opts.symbol: (optional) HollaEx trading symbol e.g. xht-usdt
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
List of last trades
getTradesHistory
  • opts: Object with additional params
  • opts.symbol: (optional) HollaEx trading symbol e.g. xht-usdt
  • opts.side: (optional, enum=[buy, sell]) Order side
  • opts.limit: (optional, default=50, max=50) Number of items to get Number of items to get
  • opts.page: (optional, default=1) Page number of data
  • opts.orderBy: (optional) Field to order data by
  • opts.order: (optional, enum=[asc, desc]) Specify ascending or descending order
  • opts.startDate: (optional, format=ISO8601) Start date of data set
  • opts.endDate: (optional, format=ISO8601) End date of data set
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
List of trades in paginated form
getGeneratedFees
  • opts: Object with additional params
  • opts.startDate: (optional, format=ISO8601) Start date of data set
  • opts.endDate: (optional, format=ISO8601) End date of data set
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
List of generated fees for the exchange
settleFees
  • opts: Object with additional params
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Settle exchange's fees
getUser
  • userId: User HollaEx Network ID
  • opts: Object with additional params
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
User's personal information
getUsers
  • opts: Object with additional params
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Get all user's for your exchange
createUser
  • email: User email
  • opts: Object with additional params
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Create a user on the Network Note: Whilst this command will create a user on the network, it will not create that user for the kit itself (More at bottom of list)
getBalance
  • opts: Object with additional params
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Exchange's wallet balance
getUserBalance
  • userId: User HollaEx Network ID
  • opts: Object with additional params
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
User's wallet balance
createUserCryptoAddress
  • userId: User HollaEx Network ID
  • crypto: Asset to create address for e.g. xht
  • opts: Object with additional params
  • opts.network: (required if asset has multiple networks) Blockchain network to create address for e.g. trx
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Create a crypto address for a user
mintAsset
  • userId: User HollaEx Network ID
  • currency: Currency code e.g. xht
  • amount: Asset amount
  • opts: Object with additional params
  • opts.description: (optional) Custom description
  • opts.transactionId: (optional, default=Server generated TXID) Custom transaction ID
  • opts.status: (optional, default=true) Set to false to make a pending mint
  • opts.email: (optional, default=true) Set to false to not send notification email to user
  • opts.fee: (optional) Optional fee to display in data
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Mint an asset that is created by the operator for a user
updatePendingMint
  • transactionId: TXID of pending mint to update
  • opts: Object with additional params
  • opts.status: (one state update required) Set to true to confirm pending mint
  • opts.dismissed: (one state update required) Set to true to dismiss pending mint
  • opts.rejected: (one state update required) Set to true to reject pending mint
  • opts.processing: (one state update required) Set to true to set state to processing
  • opts.waiting: (one state update required) Set to true to set state to waiting
  • opts.updatedTransactionId: (optional) Custom TXID for updated mint
  • opts.email: (optional, default=true) Set to false to not send notification email to user
  • opts.updatedDescription: (optional) Custom description for updated mint
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Update a pending mint
burnAsset
  • userId: User HollaEx Network ID
  • currency: Currency code e.g. xht
  • amount: Asset amount
  • opts: Object with additional params
  • opts.description: (optional) Custom description
  • opts.transactionId: (optional, default=Server generated TXID) Custom transaction ID
  • opts.status: (optional, default=true) Set to false to make a pending burn
  • opts.email: (optional, default=true) Set to false to not send notification email to user
  • opts.fee: (optional) Optional fee to display in data
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Burn an asset that is created by the operator from a user
updatePendingBurn
  • transactionId: TXID of pending burn to update
  • opts: Object with additional params
  • opts.status: (one state update required) Set to true to confirm pending burn
  • opts.dismissed: (one state update required) Set to true to dismiss pending burn
  • opts.rejected: (one state update required) Set to true to reject pending burn
  • opts.processing: (one state update required) Set to true to set state to processing
  • opts.waiting: (one state update required) Set to true to set state to waiting
  • opts.updatedTransactionId: (optional) Custom TXID for updated burn
  • opts.email: (optional, default=true) Set to false to not send notification email to user
  • opts.updatedDescription: (optional) Custom description for updated burn
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Update a pending burn
getDeposits
  • opts: Object with additional params
  • opts.currency: (optional) Filter data set by asset
  • opts.status: (optional) Filter data set status
  • opts.dismissed: (optional) Filter data set dismissed
  • opts.rejected: (optional) Filter data set rejected
  • opts.processing: (optional) Filter data set processing
  • opts.waiting: (optional) Filter data set waiting
  • opts.limit: (optional, default=50, max=50) Number of items to get
  • opts.page: (optional, default=1) Page number of data
  • opts.orderBy: (optional) Field to order data by
  • opts.order: (optional, enum=[asc, desc]) Specify ascending or descending order
  • opts.startDate: (optional, format=ISO8601) Start date of data set
  • opts.endDate: (optional, format=ISO8601) End date of data set
  • opts.transactionId: (optional) Filter data set by TXID
  • opts.address: (optional) Filter data set by address
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Exchanges's list of all deposits
getUserDeposits
  • userId: User HollaEx Network ID
  • opts: Object with additional params
  • opts.currency: (optional) Filter data set by asset
  • opts.status: (optional) Filter data set status
  • opts.dismissed: (optional) Filter data set dismissed
  • opts.rejected: (optional) Filter data set rejected
  • opts.processing: (optional) Filter data set processing
  • opts.waiting: (optional) Filter data set waiting
  • opts.limit: (optional, default=50, max=50) Number of items to get
  • opts.page: (optional, default=1) Page number of data
  • opts.orderBy: (optional) Field to order data by
  • opts.order: (optional, enum=[asc, desc]) Specify ascending or descending order
  • opts.startDate: (optional, format=ISO8601) Start date of data set
  • opts.endDate: (optional, format=ISO8601) End date of data set
  • opts.transactionId: (optional) Filter data set by TXID
  • opts.address: (optional) Filter data set by address
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
User's list of all deposits
getWithdrawals
  • opts: Object with additional params
  • opts.currency: (optional) Filter data set by asset
  • opts.status: (optional) Filter data set status
  • opts.dismissed: (optional) Filter data set dismissed
  • opts.rejected: (optional) Filter data set rejected
  • opts.processing: (optional) Filter data set processing
  • opts.waiting: (optional) Filter data set waiting
  • opts.limit: (optional, default=50, max=50) Number of items to get
  • opts.page: (optional, default=1) Page number of data
  • opts.orderBy: (optional) Field to order data by
  • opts.order: (optional, enum=[asc, desc]) Specify ascending or descending order
  • opts.startDate: (optional, format=ISO8601) Start date of data set
  • opts.endDate: (optional, format=ISO8601) End date of data set
  • opts.transactionId: (optional) Filter data set by TXID
  • opts.address: (optional) Filter data set by address
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Exchange's list of all withdrawals
getUserWithdrawals
  • userId: User HollaEx Network ID
  • opts: Object with additional params
  • opts.currency: (optional) Filter data set by asset
  • opts.limit: (optional, default=50, max=50) Number of items to get
  • opts.page: (optional, default=1) Page number of data
  • opts.orderBy: (optional) Field to order data by
  • opts.order: (optional, enum=[asc, desc]) Specify ascending or descending order
  • opts.startDate: (optional, format=ISO8601) Start date of data set
  • opts.endDate: (optional, format=ISO8601) End date of data set
  • opts.transactionId: (optional) Filter data set by TXID
  • opts.address: (optional) Filter data set by address
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
User's list of all withdrawals
performWithdrawal
  • userId: User HollaEx Network ID
  • address: Address to withdrawal to
  • currency: Currency code e.g. xht
  • amount: Withdrawal amount
  • opts: Object with additional params
  • opts.network: (required if asset has multiple networks) Blockchain network to create address for e.g. trx
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Create a withdrawal for an exchange's user on the network
cancelWithdrawal
  • userId: User HollaEx Network ID
  • withdrawalId: HollaEx Network ID of withdrawal to cancel
  • opts: Object with additional params
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Cancel a pending withdrawal
checkTransaction
  • userId: User HollaEx Network ID
  • transactionId: TXID of transaction to check
  • address: Address of transaction
  • network: Blockchain network to create address for e.g. trx
  • opts: Object with additional params
  • opts.isTestnet: (optional) Specify transaction was made on testnet blockchain
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Check transaction in network. Will update transaction status on Kit accordingly
transferAsset
  • senderId: HollaEx Network ID of sending user
  • receiverId: HollaEx Network ID of receiving user
  • currency: Currency code e.g. xht
  • amount: Asset amount to transfer
  • opts: Object with additional params
  • opts.description: (optional) Custom description
  • opts.email: (optional, default=true) Set to false to not send notification email to user
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Transfer funds between two users
getTrades
  • opts: Object with additional params
  • opts.symbol: (optional) HollaEx trading symbol e.g. xht-usdt
  • opts.limit: (optional, default=50, max=50) Number of items to get
  • opts.page: (optional, default=1) Page number of data
  • opts.orderBy: (optional) Field to order data by
  • opts.order: (optional, enum=[asc, desc]) Specify ascending or descending order
  • opts.startDate: (optional, format=ISO8601) Start date of data set
  • opts.endDate: (optional, format=ISO8601) End date of data set
  • opts.format: (optional, enum=[all]) Custom format of data set
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Exchange's list of all trades
getUserTrades
  • userId: User HollaEx Network ID
  • opts: Object with additional params
  • opts.symbol: (optional) HollaEx trading symbol e.g. xht-usdt
  • opts.limit: (optional, default=50, max=50) Number of items to get
  • opts.page: (optional, default=1) Page number of data
  • opts.orderBy: (optional) Field to order data by
  • opts.order: (optional, enum=[asc, desc]) Specify ascending or descending order
  • opts.startDate: (optional, format=ISO8601) Start date of data set
  • opts.endDate: (optional, format=ISO8601) End date of data set
  • opts.format: (optional, enum=[all]) Custom format of data set
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
User's list of all trades
getUserStats
  • userId: User HollaEx Network ID
  • opts: Object with additional params
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Get sum of user trades and its stats
getOrder
  • userId: User HollaEx Network ID
  • orderId: HollaEx Network Order ID
  • opts: Object with additional params
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Get specific information about a certain order
getOrders
  • opts: Object with additional params
  • opts.symbol: (optional) HollaEx trading symbol e.g. xht-usdt
  • opts.side: (optional, enum=[buy, sell]) Order side
  • opts.status: (optional) Filter data set status
  • opts.limit: (optional, default=50, max=50) Number of items to get
  • opts.page: (optional, default=1) Page number of data
  • opts.orderBy: (optional) Field to order data by
  • opts.order: (optional, enum=[asc, desc])
  • opts.startDate: (optional, format=ISO8601) Start date of data set
  • opts.endDate: (optional, format=ISO8601) End date of data set
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Get the list of all orders for the exchange
getUserOrders
  • userId: User HollaEx Network ID
  • opts: Object with additional params
  • opts.symbol: (optional) HollaEx trading symbol e.g. xht-usdt
  • opts.side: (optional, enum=[buy, sell]) Order side
  • opts.status: (optional) Filter data set status
  • opts.limit: (optional, default=50, max=50) Number of items to get
  • opts.page: (optional, default=1) Page number of data
  • opts.orderBy: (optional) Field to order data by
  • opts.order: (optional, enum=[asc, desc])
  • opts.startDate: (optional, format=ISO8601) Start date of data set
  • opts.endDate: (optional, format=ISO8601) End date of data set
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Get the list of all orders for a user
createOrder
  • userId: User HollaEx Network ID
  • symbol: HollaEx trading symbol e.g. xht-usdt
  • side (enum=[buy, sell]): Order side
  • size: Size of order to place
  • type: (enum=[market, limit] Order type
  • price: (required if limit order type) Order price
  • feeData: object with fee data
  • feeData.fee_structure: Object with maker and taker fee
  • feeData.fee_structure.maker: Maker fee percentage
  • feeData.fee_structure.taker: Taker fee percentage
  • feeData.fee_coin: (optional) Coin to pay fee with
  • opts: Object with additional params
  • opts.stop: (optional) Stop price for order
  • opts.meta: (optional) Object with additional meta configurations
  • opts.meta.post_only: (optional) Make post only order
  • opts.meta.note: (optional) Custom note for order
  • opts.additionalHeaders: (optional) Object containing addtional headers to send with request
Create a new order
cancelOrder
  • userId: User HollaEx Network ID
  • orderId: HollaEx Network order ID
  • opts: Object with additional params
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Cancel a specific order with its ID
cancelAllOrders
  • userId: User HollaEx Network ID
  • symbol: HollaEx trading symbol e.g. xht-usdt
  • opts: Object with additional params
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Cancel all open order. It can be filtered by passing the symbol
getPublicTrades
  • opts: Object with additional params
  • opts.symbol: (optional) HollaEx trading symbol e.g. xht-usdt
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Get public trades on Network
getChart
  • from: Start date of data set
  • to: End date of data set
  • symbol: HollaEx trading symbol e.g. xht-usdt
  • resolution: (enum=[1m, 5m, 1h, 1d, 7d, 1W, 30d, 1M]) Resolution of data set
  • opts: Object with additional params
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Get TradingView trade history HOLCV
getCharts
  • from: Start date of data set
  • to: End date of data set
  • resolution: (enum=[1m, 5m, 1h, 1d, 7d, 1W, 30d, 1M]) Resolution of data set
  • opts: Object with additional params
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Get TradingView trade history HOLCV for all pairs
getUdfConfig
  • opts: Object with additional params
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Get TradingView udf config
getUdfHistory
  • from: Start date of data set
  • to: End date of data set
  • symbol: HollaEx trading symbol e.g. xht-usdt
  • resolution: (enum=[1m, 5m, 1h, 1d, 7d, 1W, 30d, 1M]) Resolution of data set
  • opts: Object with additional params
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Get TradingView udf history HOLCV
getUdfSymbols
  • symbol: HollaEx trading symbol e.g. xht-usdt
  • opts: Object with additional params
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Get TradingView udf symbols
getOraclePrices
  • assets: Array of assets to get converted prices for
  • opts: Object with additional params
  • opts.quote: (optional, default=usdt) Asset to convert to
  • opts.amount: (optional, default=1) Convert to specific quote amount
  • opts.additionalHeaders: (optional) Object containing additional headers to send with request
Get converted quote amount for an asset

Note on createUser Function

When using the createUser function, bear in mind that while a user will be added to the HollaEx Network and be able to interact with the Network, they will not be created through the Kit directly and thus not viewable in the actual associated exchange's user list.
The Kit will maintain its own list of users that have signed up conventionally via sign up, and users added via the Network Tools will not be tracked by the Kit, but to avoid conflicts the user's email will not be able to used for sign-ups on the exchange again.
​
Previous
Accessing the Network Tool Library
Next
WebSocket
Last modified 11mo ago