18 KiB
tokocrypto{docsify-ignore}
Kind: global class
Extends: Exchange
- fetchTime
- fetchMarkets
- fetchOrderBook
- fetchTrades
- fetchTickers
- fetchTicker
- fetchBidsAsks
- fetchOHLCV
- fetchBalance
- createOrder
- fetchOrder
- fetchOrders
- fetchOpenOrders
- fetchClosedOrders
- cancelOrder
- fetchMyTrades
- fetchDepositAddress
- fetchDeposits
- fetchWithdrawals
- withdraw
fetchTime{docsify-ignore}
fetches the current integer timestamp in milliseconds from the exchange server
Kind: instance method of tokocrypto
Returns: int - the current integer timestamp in milliseconds from the exchange server
See: https://www.tokocrypto.com/apidocs/#check-server-time
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
tokocrypto.fetchTime ([params])
fetchMarkets{docsify-ignore}
retrieves data on all markets for tokocrypto
Kind: instance method of tokocrypto
Returns: Array<object> - an array of objects representing market data
See: https://www.tokocrypto.com/apidocs/#get-all-supported-trading-symbol
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
tokocrypto.fetchMarkets ([params])
fetchOrderBook{docsify-ignore}
fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of tokocrypto
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://www.tokocrypto.com/apidocs/#order-book
| 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 |
tokocrypto.fetchOrderBook (symbol[, limit, params])
fetchTrades{docsify-ignore}
get the list of most recent trades for a particular symbol
Kind: instance method of tokocrypto
Returns: Array<Trade> - a list of trade structures
See
- https://www.tokocrypto.com/apidocs/#recent-trades-list
- https://www.tokocrypto.com/apidocs/#compressedaggregate-trades-list
| 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 |
tokocrypto.fetchTrades (symbol[, since, limit, 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 tokocrypto
Returns: object - a dictionary of ticker structures
See: https://binance-docs.github.io/apidocs/spot/en/#24hr-ticker-price-change-statistics
| 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 |
tokocrypto.fetchTickers (symbols[, 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 tokocrypto
Returns: object - a ticker structure
See: https://binance-docs.github.io/apidocs/spot/en/#24hr-ticker-price-change-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 |
tokocrypto.fetchTicker (symbol[, params])
fetchBidsAsks{docsify-ignore}
fetches the bid and ask price and volume for multiple markets
Kind: instance method of tokocrypto
Returns: object - a dictionary of ticker structures
See: https://binance-docs.github.io/apidocs/spot/en/#symbol-order-book-ticker
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string>, undefined |
Yes | unified symbols of the markets to fetch the bids and asks for, all markets are returned if not assigned |
| params | object |
No | extra parameters specific to the exchange API endpoint |
tokocrypto.fetchBidsAsks (symbols[, 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 tokocrypto
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://binance-docs.github.io/apidocs/spot/en/#kline-candlestick-data
| 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.price | string |
No | "mark" or "index" for mark price and index price candles |
| params.until | int |
No | timestamp in ms of the latest candle to fetch |
tokocrypto.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 tokocrypto
Returns: object - a balance structure
See: https://www.tokocrypto.com/apidocs/#account-information-signed
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.type | string |
No | 'future', 'delivery', 'savings', 'funding', or 'spot' |
| params.marginMode | string |
No | 'cross' or 'isolated', for margin trading, uses this.options.defaultMarginMode if not passed, defaults to undefined/None/null |
| params.symbols | Array<string>, undefined |
No | unified market symbols, only used in isolated margin mode |
tokocrypto.fetchBalance ([params])
createOrder{docsify-ignore}
create a trade order
Kind: instance method of tokocrypto
Returns: object - an order structure
See: https://www.tokocrypto.com/apidocs/#new-order--signed
| 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 would be triggered |
| params.cost | float |
No | for spot market buy orders, the quote quantity that can be used as an alternative for the amount |
tokocrypto.createOrder (symbol, type, side, amount[, price, params])
fetchOrder{docsify-ignore}
fetches information on an order made by the user
Kind: instance method of tokocrypto
Returns: object - An order structure
See: https://www.tokocrypto.com/apidocs/#query-order-signed
| 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 |
tokocrypto.fetchOrder (id, symbol[, params])
fetchOrders{docsify-ignore}
fetches information on multiple orders made by the user
Kind: instance method of tokocrypto
Returns: Array<Order> - a list of order structures
See: https://www.tokocrypto.com/apidocs/#all-orders-signed
| 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 |
tokocrypto.fetchOrders (symbol[, since, limit, params])
fetchOpenOrders{docsify-ignore}
fetch all unfilled currently open orders
Kind: instance method of tokocrypto
Returns: Array<Order> - a list of order structures
See: https://www.tokocrypto.com/apidocs/#all-orders-signed
| 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 |
tokocrypto.fetchOpenOrders (symbol[, since, limit, params])
fetchClosedOrders{docsify-ignore}
fetches information on multiple closed orders made by the user
Kind: instance method of tokocrypto
Returns: Array<Order> - a list of order structures
See: https://www.tokocrypto.com/apidocs/#all-orders-signed
| 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 |
tokocrypto.fetchClosedOrders (symbol[, since, limit, params])
cancelOrder{docsify-ignore}
cancels an open order
Kind: instance method of tokocrypto
Returns: object - An order structure
See: https://www.tokocrypto.com/apidocs/#cancel-order-signed
| 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 |
tokocrypto.cancelOrder (id, symbol[, params])
fetchMyTrades{docsify-ignore}
fetch all trades made by the user
Kind: instance method of tokocrypto
Returns: Array<Trade> - a list of trade structures
See: https://www.tokocrypto.com/apidocs/#account-trade-list-signed
| 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 |
tokocrypto.fetchMyTrades (symbol[, since, limit, params])
fetchDepositAddress{docsify-ignore}
fetch the deposit address for a currency associated with this account
Kind: instance method of tokocrypto
Returns: object - an address structure
See: https://www.tokocrypto.com/apidocs/#deposit-address-signed
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | unified currency code |
| params | object |
No | extra parameters specific to the exchange API endpoint |
tokocrypto.fetchDepositAddress (code[, params])
fetchDeposits{docsify-ignore}
fetch all deposits made to an account
Kind: instance method of tokocrypto
Returns: Array<object> - a list of transaction structures
See: https://www.tokocrypto.com/apidocs/#deposit-history-signed
| 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 |
| params.until | int |
No | the latest time in ms to fetch deposits for |
tokocrypto.fetchDeposits (code[, since, limit, params])
fetchWithdrawals{docsify-ignore}
fetch all withdrawals made from an account
Kind: instance method of tokocrypto
Returns: Array<object> - a list of transaction structures
See: https://www.tokocrypto.com/apidocs/#withdraw-signed
| 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 |
tokocrypto.fetchWithdrawals (code[, since, limit, params])
withdraw{docsify-ignore}
make a withdrawal
Kind: instance method of tokocrypto
Returns: object - a transaction structure
See: https://www.tokocrypto.com/apidocs/#withdraw-signed
| 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 |
tokocrypto.withdraw (code, amount, address, tag[, params])