Functions

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
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.
​

Network - Previous

Accessing the Network Tool Library

Next - Network

WebSocket

Last modified 6d ago

Copy link

Contents

Available Functions: