ccxt
Version:
52 lines (51 loc) • 2.89 kB
TypeScript
import coinoneRest from '../coinone.js';
import type { Int, Market, OrderBook, Ticker, Trade, Dict } from '../base/types.js';
import Client from '../base/ws/Client.js';
export default class coinone extends coinoneRest {
describe(): any;
/**
* @method
* @name coinone#watchOrderBook
* @description watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
* @see https://docs.coinone.co.kr/reference/public-websocket-orderbook
* @param {string} symbol unified symbol of the market to fetch the order book for
* @param {int} [limit] the maximum amount of order book entries to return
* @param {object} [params] extra parameters specific to the exchange API endpoint
* @returns {object} A dictionary of [order book structures]{@link https://docs.ccxt.com/#/?id=order-book-structure} indexed by market symbols
*/
watchOrderBook(symbol: string, limit?: Int, params?: {}): Promise<OrderBook>;
handleOrderBook(client: any, message: any): void;
handleDelta(bookside: any, delta: any): void;
/**
* @method
* @name coinone#watchTicker
* @description watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
* @see https://docs.coinone.co.kr/reference/public-websocket-ticker
* @param {string} symbol unified symbol of the market to fetch the ticker for
* @param {object} [params] extra parameters specific to the exchange API endpoint
* @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
*/
watchTicker(symbol: string, params?: {}): Promise<Ticker>;
handleTicker(client: Client, message: any): void;
parseWsTicker(ticker: any, market?: Market): Ticker;
/**
* @method
* @name coinone#watchTrades
* @description watches information on multiple trades made in a market
* @see https://docs.coinone.co.kr/reference/public-websocket-trade
* @param {string} symbol unified market symbol of the market trades were made in
* @param {int} [since] the earliest time in ms to fetch trades for
* @param {int} [limit] the maximum number of trade structures to retrieve
* @param {object} [params] extra parameters specific to the exchange API endpoint
* @returns {object[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=trade-structure}
*/
watchTrades(symbol: string, since?: Int, limit?: Int, params?: {}): Promise<Trade[]>;
handleTrades(client: Client, message: any): void;
parseWsTrade(trade: Dict, market?: Market): Trade;
handleErrorMessage(client: Client, message: any): boolean;
handleMessage(client: Client, message: any): void;
ping(client: Client): {
request_type: string;
};
handlePong(client: Client, message: any): any;
}