13 KiB
zonda{docsify-ignore}
Kind: global class
Extends: Exchange
- fetchMarkets
- fetchOpenOrders
- fetchMyTrades
- fetchBalance
- fetchOrderBook
- fetchTicker
- fetchLedger
- fetchOHLCV
- fetchTrades
- createOrder
- cancelOrder
- fetchDepositAddress
- fetchDepositAddresses
- transfer
- withdraw
fetchMarkets{docsify-ignore}
retrieves data on all markets for zonda
Kind: instance method of zonda
Returns: Array<object> - an array of objects representing market data
See: https://docs.zondacrypto.exchange/reference/ticker-1
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
zonda.fetchMarkets ([params])
fetchOpenOrders{docsify-ignore}
fetch all unfilled currently open orders
Kind: instance method of zonda
Returns: Array<Order> - a list of order structures
See: https://docs.zondacrypto.exchange/reference/active-orders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | not used by zonda fetchOpenOrders |
| 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 |
zonda.fetchOpenOrders (symbol[, since, limit, params])
fetchMyTrades{docsify-ignore}
fetch all trades made by the user
Kind: instance method of zonda
Returns: Array<Trade> - a list of trade structures
See: https://docs.zondacrypto.exchange/reference/transactions-history
| 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 |
zonda.fetchMyTrades (symbol[, 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 zonda
Returns: object - a balance structure
See: https://docs.zondacrypto.exchange/reference/list-of-wallets
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
zonda.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 zonda
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://docs.zondacrypto.exchange/reference/orderbook-2
| 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 |
zonda.fetchOrderBook (symbol[, limit, params])
fetchTicker{docsify-ignore}
v1_01PublicGetTradingTickerSymbol retrieves timestamp, datetime, bid, ask, close, last, previousClose, v1_01PublicGetTradingStatsSymbol retrieves high, low, volume and opening price of an asset
Kind: instance method of zonda
Returns: object - a ticker structure
See: https://docs.zondacrypto.exchange/reference/market-statistics
| 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 |
| params.method | string |
No | v1_01PublicGetTradingTickerSymbol (default) or v1_01PublicGetTradingStatsSymbol |
zonda.fetchTicker (symbol[, params])
fetchLedger{docsify-ignore}
fetch the history of changes, actions done by the user or operations that altered the balance of the user
Kind: instance method of zonda
Returns: object - a ledger structure
See: https://docs.zondacrypto.exchange/reference/operations-history
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
No | unified currency code, default is undefined |
| since | int |
No | timestamp in ms of the earliest ledger entry, default is undefined |
| limit | int |
No | max number of ledger entries to return, default is undefined |
| params | object |
No | extra parameters specific to the exchange API endpoint |
zonda.fetchLedger ([code, since, limit, params])
fetchOHLCV{docsify-ignore}
fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of zonda
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://docs.zondacrypto.exchange/reference/candles-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 |
| params | object |
No | extra parameters specific to the exchange API endpoint |
zonda.fetchOHLCV (symbol, timeframe[, since, limit, params])
fetchTrades{docsify-ignore}
get the list of most recent trades for a particular symbol
Kind: instance method of zonda
Returns: Array<Trade> - a list of trade structures
See: https://docs.zondacrypto.exchange/reference/last-transactions
| 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 |
zonda.fetchTrades (symbol[, since, limit, params])
createOrder{docsify-ignore}
create a trade order
Kind: instance method of zonda
Returns: object - an order structure
See: https://docs.zondacrypto.exchange/reference/new-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 |
zonda.createOrder (symbol, type, side, amount[, price, params])
cancelOrder{docsify-ignore}
cancels an open order
Kind: instance method of zonda
Returns: object - An order structure
See: https://docs.zondacrypto.exchange/reference/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 |
zonda.cancelOrder (id, symbol[, params])
fetchDepositAddress{docsify-ignore}
fetch the deposit address for a currency associated with this account
Kind: instance method of zonda
Returns: object - an address structure
See: https://docs.zondacrypto.exchange/reference/deposit-addresses-for-crypto
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | unified currency code |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.walletId | string |
No | Wallet id to filter deposit adresses. |
zonda.fetchDepositAddress (code[, params])
fetchDepositAddresses{docsify-ignore}
fetch deposit addresses for multiple currencies and chain types
Kind: instance method of zonda
Returns: object - a list of address structures
See: https://docs.zondacrypto.exchange/reference/deposit-addresses-for-crypto
| Param | Type | Required | Description |
|---|---|---|---|
| codes | Array<string>, undefined |
Yes | zonda does not support filtering filtering by multiple codes and will ignore this parameter. |
| params | object |
No | extra parameters specific to the exchange API endpoint |
zonda.fetchDepositAddresses (codes[, params])
transfer{docsify-ignore}
transfer currency internally between wallets on the same account
Kind: instance method of zonda
Returns: object - a transfer structure
See: https://docs.zondacrypto.exchange/reference/internal-transfer
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | unified currency code |
| amount | float |
Yes | amount to transfer |
| fromAccount | string |
Yes | account to transfer from |
| toAccount | string |
Yes | account to transfer to |
| params | object |
No | extra parameters specific to the exchange API endpoint |
zonda.transfer (code, amount, fromAccount, toAccount[, params])
withdraw{docsify-ignore}
make a withdrawal
Kind: instance method of zonda
Returns: object - a transaction structure
See: https://docs.zondacrypto.exchange/reference/crypto-withdrawal-1
| 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 |
zonda.withdraw (code, amount, address, tag[, params])