22 KiB
hibachi{docsify-ignore}
Kind: global class
Extends: Exchange
- fetchMarkets
- fetchCurrencies
- fetchBalance
- fetchTrades
- fetchTicker
- fetchOrder
- fetchTradingFees
- createOrder
- createOrders
- editOrder
- editOrders
- cancelOrder
- cancelOrders
- cancelAllOrders
- withdraw
- fetchOrderBook
- fetchMyTrades
- fetchOpenOrders
- fetchPositions
- fetchLedger
- fetchDepositAddress
- fetchDeposits
- fetchWithdrawals
- fetchTime
- fetchOpenInterest
- fetchFundingRate
- fetchFundingRateHistory
fetchOHLCV{docsify-ignore}
fetches historical candlestick data containing the close, high, low, open prices, interval and the volumeNotional
Kind: instance property of hibachi
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://api-doc.hibachi.xyz/#4f0eacec-c61e-4d51-afb3-23c51c2c6bac
| 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 |
| params.until | int |
No | timestamp in ms of the latest candle to fetch |
hibachi.fetchOHLCV (symbol, timeframe[, since, limit, params])
fetchMarkets{docsify-ignore}
retrieves data on all markets for hibachi
Kind: instance method of hibachi
Returns: Array<object> - an array of objects representing market data
See: https://api-doc.hibachi.xyz/#183981da-8df5-40a0-a155-da15015dd536
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
hibachi.fetchMarkets ([params])
fetchCurrencies{docsify-ignore}
fetches all available currencies on an exchange
Kind: instance method of hibachi
Returns: object - an associative dictionary of currencies
See: https://api-doc.hibachi.xyz/#183981da-8df5-40a0-a155-da15015dd536
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
hibachi.fetchCurrencies ([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 hibachi
Returns: object - a balance structure
See: https://api-doc.hibachi.xyz/#69aafedb-8274-4e21-bbaf-91dace8b8f31
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
hibachi.fetchBalance ([params])
fetchTrades{docsify-ignore}
get the list of most recent trades for a particular symbol
Kind: instance method of hibachi
Returns: Array<object> - a list of recent [trade structures]
See: https://api-doc.hibachi.xyz/#86a53bc1-d3bb-4b93-8a11-7034d4698caa
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol |
| since | int |
No | timestamp in ms of the earliest trade to fetch |
| limit | int |
No | the maximum amount of trades to fetch (maximum value is 100) |
| params | object |
No | extra parameters specific to the hibachi api endpoint |
hibachi.fetchTrades (symbol[, since, limit, params])
fetchTicker{docsify-ignore}
fetches a price ticker and the related information for the past 24h
Kind: instance method of hibachi
Returns: object - a ticker structure
See: https://api-doc.hibachi.xyz/#4abb30c4-e5c7-4b0f-9ade-790111dbfa47
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market |
| params | object |
No | extra parameters specific to the hibachi api endpoint |
hibachi.fetchTicker (symbol[, params])
fetchOrder{docsify-ignore}
fetches information on an order made by the user
Kind: instance method of hibachi
Returns: object - An order structure
See: https://api-doc.hibachi.xyz/#096a8854-b918-4de8-8731-b2a28d26b96d
| Param | Type | Required | Description |
|---|---|---|---|
| id | string |
Yes | the 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 |
hibachi.fetchOrder (id, symbol[, params])
fetchTradingFees{docsify-ignore}
fetch the trading fee
Kind: instance method of hibachi
Returns: object - a map of market symbols to fee structures
| Param | Description |
|---|---|
| params | extra parameters |
hibachi.fetchTradingFees (params, [undefined])
createOrder{docsify-ignore}
create a trade order
Kind: instance method of hibachi
Returns: object - an order structure
See: https://api-doc.hibachi.xyz/#00f6d5ad-5275-41cb-a1a8-19ed5d142124
| 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 |
hibachi.createOrder (symbol, type, side, amount[, price, params])
createOrders{docsify-ignore}
contract only create a list of trade orders
Kind: instance method of hibachi
Returns: object - an order structure
See: https://api-doc.hibachi.xyz/#c2840b9b-f02c-44ed-937d-dc2819f135b4
| Param | Type | Required | Description |
|---|---|---|---|
| orders | Array |
Yes | list of orders to create, each object should contain the parameters required by createOrder, namely symbol, type, side, amount, price and params |
| params | object |
No | extra parameters specific to the exchange API endpoint |
hibachi.createOrders (orders[, params])
editOrder{docsify-ignore}
edit a limit order that is not matched
Kind: instance method of hibachi
Returns: object - an order structure
See: https://api-doc.hibachi.xyz/#94d2cdaf-1c71-440f-a981-da1112824810
| Param | Type | Required | Description |
|---|---|---|---|
| id | string |
Yes | order id |
| symbol | string |
Yes | unified symbol of the market to create an order in |
| type | string |
Yes | must be 'limit' |
| side | string |
Yes | 'buy' or 'sell', should stay the same with original side |
| 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 |
| params | object |
No | extra parameters specific to the exchange API endpoint |
hibachi.editOrder (id, symbol, type, side, amount[, price, params])
editOrders{docsify-ignore}
edit a list of trade orders
Kind: instance method of hibachi
Returns: object - an order structure
See: https://api-doc.hibachi.xyz/#c2840b9b-f02c-44ed-937d-dc2819f135b4
| Param | Type | Required | Description |
|---|---|---|---|
| orders | Array |
Yes | list of orders to edit, each object should contain the parameters required by editOrder, namely id, symbol, type, side, amount, price and params |
| params | object |
No | extra parameters specific to the exchange API endpoint |
hibachi.editOrders (orders[, params])
cancelOrder{docsify-ignore}
cancels an open order
Kind: instance method of hibachi
Returns: object - An order structure
See: https://api-doc.hibachi.xyz/#e99c4f48-e610-4b7c-b7f6-1b4bb7af0271
| Param | Type | Required | Description |
|---|---|---|---|
| id | string |
Yes | order id |
| symbol | string |
Yes | is unused |
| params | object |
No | extra parameters specific to the exchange API endpoint |
hibachi.cancelOrder (id, symbol[, params])
cancelOrders{docsify-ignore}
cancel multiple orders
Kind: instance method of hibachi
Returns: object - an list of order structures
See: https://api-doc.hibachi.xyz/#c2840b9b-f02c-44ed-937d-dc2819f135b4
| Param | Type | Required | Description |
|---|---|---|---|
| ids | Array<string> |
Yes | order ids |
| symbol | string |
No | unified market symbol, unused |
| params | object |
No | extra parameters specific to the exchange API endpoint |
hibachi.cancelOrders (ids[, symbol, params])
cancelAllOrders{docsify-ignore}
cancel all open orders in a market
Kind: instance method of hibachi
Returns: object - an list of order structures
See: https://api-doc.hibachi.xyz/#8ed24695-016e-49b2-a72d-7511ca921fee
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol |
| params | object |
No | extra parameters specific to the exchange API endpoint |
hibachi.cancelAllOrders (symbol[, params])
withdraw{docsify-ignore}
make a withdrawal
Kind: instance method of hibachi
Returns: object - a transaction structure
See: https://api-doc.hibachi.xyz/#6421625d-3e45-45fa-be9b-d2a0e780c090
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | unified currency code, only support USDT |
| 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 |
hibachi.withdraw (code, amount, address, tag[, params])
fetchOrderBook{docsify-ignore}
fetches the state of the open orders on the orderbook
Kind: instance method of hibachi
Returns: object - A dictionary containg orderbook information
See: https://api-doc.hibachi.xyz/#4abb30c4-e5c7-4b0f-9ade-790111dbfa47
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market |
| limit | int |
No | currently unused |
| params | object |
No | extra parameters to be passed -- see documentation link above |
hibachi.fetchOrderBook (symbol[, limit, params])
fetchMyTrades{docsify-ignore}
fetch all trades made by the user
Kind: instance method of hibachi
Returns: Array<Trade> - a list of trade structures
See: https://api-doc.hibachi.xyz/#0adbf143-189f-40e0-afdc-88af4cba3c79
| 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 |
hibachi.fetchMyTrades (symbol[, since, limit, params])
fetchOpenOrders{docsify-ignore}
fetches all current open orders
Kind: instance method of hibachi
Returns: Array<Order> - a list of order structures
See: https://api-doc.hibachi.xyz/#3243f8a0-086c-44c5-ab8a-71bbb7bab403
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
No | unified market symbol to filter by |
| since | int |
No | milisecond timestamp of the earliest order |
| limit | int |
No | the maximum number of open orders to return |
| params | object |
No | extra parameters |
hibachi.fetchOpenOrders ([symbol, since, limit, params])
fetchPositions{docsify-ignore}
fetch all open positions
Kind: instance method of hibachi
Returns: Array<object> - a list of position structure
See: https://api-doc.hibachi.xyz/#69aafedb-8274-4e21-bbaf-91dace8b8f31
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> |
No | list of unified market symbols |
| params | object |
No | extra parameters specific to the exchange API endpoint |
hibachi.fetchPositions ([symbols, 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 hibachi
Returns: object - a ledger structure
See: https://api-doc.hibachi.xyz/#35125e3f-d154-4bfd-8276-a48bb1c62020
| 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 |
hibachi.fetchLedger ([code, since, limit, params])
fetchDepositAddress{docsify-ignore}
fetch deposit address for given currency and chain. currently, we have a single EVM address across multiple EVM chains. Note: This method is currently only supported for trustless accounts
Kind: instance method of hibachi
Returns: object - an address structure
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | unified currency code |
| params | object |
No | extra parameters for API |
| params.publicKey | string |
No | your public key, you can get it from UI after creating API key |
hibachi.fetchDepositAddress (code[, params])
fetchDeposits{docsify-ignore}
fetch deposits made to account
Kind: instance method of hibachi
Returns: Array<object> - a list of transaction structures
See: https://api-doc.hibachi.xyz/#35125e3f-d154-4bfd-8276-a48bb1c62020
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
No | unified currency code |
| since | int |
No | filter by earliest timestamp (ms) |
| limit | int |
No | maximum number of deposits to be returned |
| params | object |
No | extra parameters to be passed to API |
hibachi.fetchDeposits ([code, since, limit, params])
fetchWithdrawals{docsify-ignore}
fetch withdrawals made from account
Kind: instance method of hibachi
Returns: Array<object> - a list of transaction structures
See: https://api-doc.hibachi.xyz/#35125e3f-d154-4bfd-8276-a48bb1c62020
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
No | unified currency code |
| since | int |
No | filter by earliest timestamp (ms) |
| limit | int |
No | maximum number of deposits to be returned |
| params | object |
No | extra parameters to be passed to API |
hibachi.fetchWithdrawals ([code, since, limit, params])
fetchTime{docsify-ignore}
fetches the current integer timestamp in milliseconds from the exchange server
Kind: instance method of hibachi
Returns: int - the current integer timestamp in milliseconds from the exchange server
See: http://api-doc.hibachi.xyz/#b5c6a3bc-243d-4d35-b6d4-a74c92495434
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
hibachi.fetchTime ([params])
fetchOpenInterest{docsify-ignore}
retrieves the open interest of a contract trading pair
Kind: instance method of hibachi
Returns: object - an open interest structurehttps://docs.ccxt.com/#/?id=open-interest-structure
See: https://api-doc.hibachi.xyz/#bc34e8ae-e094-4802-8d56-3efe3a7bad49
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified CCXT market symbol |
| params | object |
No | exchange specific parameters |
hibachi.fetchOpenInterest (symbol[, params])
fetchFundingRate{docsify-ignore}
fetch the current funding rate
Kind: instance method of hibachi
Returns: object - a funding rate structure
See: https://api-doc.hibachi.xyz/#bca696ca-b9b2-4072-8864-5d6b8c09807e
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol |
| params | object |
No | extra parameters specific to the exchange API endpoint |
hibachi.fetchFundingRate (symbol[, params])
fetchFundingRateHistory{docsify-ignore}
fetches historical funding rate prices
Kind: instance method of hibachi
Returns: Array<object> - a list of funding rate structures
See: https://api-doc.hibachi.xyz/#4abb30c4-e5c7-4b0f-9ade-790111dbfa47
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch the funding rate history for |
| since | int |
No | timestamp in ms of the earliest funding rate to fetch |
| limit | int |
No | the maximum amount of funding rate structures to fetch |
| params | object |
No | extra parameters specific to the exchange API endpoint |
hibachi.fetchFundingRateHistory (symbol[, since, limit, params])