@jalmonter/ccxt
Version:
331 lines (330 loc) • 13.4 kB
TypeScript
import Exchange from './abstract/okx.js';
import type { Int, OrderSide, OrderType, Trade, OHLCV, Order, FundingRateHistory, OrderRequest, FundingHistory, Str, Transaction, Ticker, OrderBook, Balances, Tickers, Market, Greeks, Strings, MarketInterface, Currency } from './base/types.js';
/**
* @class okx
* @augments Exchange
*/
export default class okx extends Exchange {
describe(): any;
handleMarketTypeAndParams(methodName: any, market?: any, params?: {}): any;
convertToInstrumentType(type: any): string;
convertExpireDate(date: any): string;
createExpiredOptionMarket(symbol: any): MarketInterface;
market(symbol: any): any;
safeMarket(marketId?: any, market?: any, delimiter?: any, marketType?: any): MarketInterface;
fetchStatus(params?: {}): Promise<{
updated: any;
status: string;
eta: any;
url: any;
info: any;
}>;
fetchTime(params?: {}): Promise<number>;
fetchAccounts(params?: {}): Promise<any[]>;
fetchMarkets(params?: {}): Promise<any[]>;
parseMarket(market: any): Market;
fetchMarketsByType(type: any, params?: {}): Promise<MarketInterface[]>;
safeNetwork(networkId: any): string;
fetchCurrencies(params?: {}): Promise<{}>;
fetchOrderBook(symbol: string, limit?: Int, params?: {}): Promise<OrderBook>;
parseTicker(ticker: any, market?: Market): Ticker;
fetchTicker(symbol: string, params?: {}): Promise<Ticker>;
fetchTickersByType(type: any, symbols?: Strings, params?: {}): Promise<import("./base/types.js").Dictionary<Ticker>>;
fetchTickers(symbols?: Strings, params?: {}): Promise<Tickers>;
parseTrade(trade: any, market?: Market): Trade;
fetchTrades(symbol: string, since?: Int, limit?: Int, params?: {}): Promise<Trade[]>;
parseOHLCV(ohlcv: any, market?: Market): OHLCV;
fetchOHLCV(symbol: string, timeframe?: string, since?: Int, limit?: Int, params?: {}): Promise<OHLCV[]>;
fetchFundingRateHistory(symbol?: Str, since?: Int, limit?: Int, params?: {}): Promise<FundingRateHistory[]>;
parseBalanceByType(type: any, response: any): Balances;
parseTradingBalance(response: any): Balances;
parseFundingBalance(response: any): Balances;
parseTradingFee(fee: any, market?: Market): {
info: any;
symbol: string;
maker: number;
taker: number;
};
fetchTradingFee(symbol: string, params?: {}): Promise<{
info: any;
symbol: string;
maker: number;
taker: number;
}>;
fetchBalance(params?: {}): Promise<Balances>;
createMarketBuyOrderWithCost(symbol: string, cost: any, params?: {}): Promise<Order>;
createMarketSellOrderWithCost(symbol: string, cost: any, params?: {}): Promise<Order>;
createOrderRequest(symbol: string, type: OrderType, side: OrderSide, amount: any, price?: any, params?: {}): any;
createOrder(symbol: string, type: OrderType, side: OrderSide, amount: any, price?: any, params?: {}): Promise<Order>;
createOrders(orders: OrderRequest[], params?: {}): Promise<Order[]>;
editOrderRequest(id: string, symbol: any, type: any, side: any, amount?: any, price?: any, params?: {}): any;
editOrder(id: string, symbol: any, type: any, side: any, amount?: any, price?: any, params?: {}): Promise<Order>;
cancelOrder(id: string, symbol?: Str, params?: {}): Promise<any>;
parseIds(ids: any): any;
cancelOrders(ids: any, symbol?: Str, params?: {}): Promise<Order[]>;
parseOrderStatus(status: any): string;
parseOrder(order: any, market?: Market): Order;
fetchOrder(id: string, symbol?: Str, params?: {}): Promise<Order>;
fetchOpenOrders(symbol?: Str, since?: Int, limit?: Int, params?: {}): Promise<Order[]>;
fetchCanceledOrders(symbol?: Str, since?: Int, limit?: Int, params?: {}): Promise<Order[]>;
fetchClosedOrders(symbol?: Str, since?: Int, limit?: Int, params?: {}): Promise<Order[]>;
fetchMyTrades(symbol?: Str, since?: Int, limit?: Int, params?: {}): Promise<Trade[]>;
fetchOrderTrades(id: string, symbol?: Str, since?: Int, limit?: Int, params?: {}): Promise<Trade[]>;
fetchLedger(code?: Str, since?: Int, limit?: Int, params?: {}): Promise<any>;
parseLedgerEntryType(type: any): string;
parseLedgerEntry(item: any, currency?: Currency): {
id: string;
info: any;
timestamp: number;
datetime: string;
account: any;
referenceId: string;
referenceAccount: any;
type: string;
currency: string;
symbol: string;
amount: number;
before: any;
after: number;
status: string;
fee: any;
};
parseDepositAddress(depositAddress: any, currency?: Currency): {
currency: string;
address: string;
tag: string;
network: string;
info: any;
};
fetchDepositAddressesByNetwork(code: string, params?: {}): Promise<{}>;
fetchDepositAddress(code: string, params?: {}): Promise<any>;
withdraw(code: string, amount: any, address: any, tag?: any, params?: {}): Promise<Transaction>;
fetchDeposits(code?: Str, since?: Int, limit?: Int, params?: {}): Promise<Transaction[]>;
fetchDeposit(id: string, code?: Str, params?: {}): Promise<Transaction>;
fetchWithdrawals(code?: Str, since?: Int, limit?: Int, params?: {}): Promise<Transaction[]>;
fetchWithdrawal(id: string, code?: Str, params?: {}): Promise<Transaction>;
parseTransactionStatus(status: any): string;
parseTransaction(transaction: any, currency?: Currency): Transaction;
fetchLeverage(symbol: string, params?: {}): Promise<any>;
fetchPosition(symbol: string, params?: {}): Promise<import("./base/types.js").Position>;
fetchPositions(symbols?: Strings, params?: {}): Promise<import("./base/types.js").Position[]>;
fetchPositionsForSymbol(symbol: string, params?: {}): Promise<import("./base/types.js").Position[]>;
parsePosition(position: any, market?: Market): import("./base/types.js").Position;
transfer(code: string, amount: any, fromAccount: any, toAccount: any, params?: {}): Promise<{
info: any;
id: string;
timestamp: number;
datetime: string;
currency: string;
amount: number;
fromAccount: string;
toAccount: string;
status: string;
}>;
parseTransfer(transfer: any, currency?: Currency): {
info: any;
id: string;
timestamp: number;
datetime: string;
currency: string;
amount: number;
fromAccount: string;
toAccount: string;
status: string;
};
parseTransferStatus(status: any): string;
fetchTransfer(id: string, code?: Str, params?: {}): Promise<{
info: any;
id: string;
timestamp: number;
datetime: string;
currency: string;
amount: number;
fromAccount: string;
toAccount: string;
status: string;
}>;
fetchTransfers(code?: Str, since?: Int, limit?: Int, params?: {}): Promise<any>;
sign(path: any, api?: string, method?: string, params?: {}, headers?: any, body?: any): {
url: string;
method: string;
body: any;
headers: any;
};
parseFundingRate(contract: any, market?: Market): {
info: any;
symbol: string;
markPrice: any;
indexPrice: any;
interestRate: number;
estimatedSettlePrice: any;
timestamp: any;
datetime: any;
fundingRate: number;
fundingTimestamp: number;
fundingDatetime: string;
nextFundingRate: number;
nextFundingTimestamp: number;
nextFundingDatetime: string;
previousFundingRate: any;
previousFundingTimestamp: any;
previousFundingDatetime: any;
};
fetchFundingRate(symbol: string, params?: {}): Promise<{
info: any;
symbol: string;
markPrice: any;
indexPrice: any;
interestRate: number;
estimatedSettlePrice: any;
timestamp: any;
datetime: any;
fundingRate: number;
fundingTimestamp: number;
fundingDatetime: string;
nextFundingRate: number;
nextFundingTimestamp: number;
nextFundingDatetime: string;
previousFundingRate: any;
previousFundingTimestamp: any;
previousFundingDatetime: any;
}>;
fetchFundingHistory(symbol?: Str, since?: Int, limit?: Int, params?: {}): Promise<FundingHistory[]>;
setLeverage(leverage: any, symbol?: Str, params?: {}): Promise<any>;
setPositionMode(hedged: any, symbol?: Str, params?: {}): Promise<any>;
setMarginMode(marginMode: any, symbol?: Str, params?: {}): Promise<any>;
fetchCrossBorrowRates(params?: {}): Promise<any[]>;
fetchCrossBorrowRate(code: string, params?: {}): Promise<{
currency: string;
rate: number;
period: number;
timestamp: number;
datetime: string;
info: any;
}>;
parseBorrowRate(info: any, currency?: Currency): {
currency: string;
rate: number;
period: number;
timestamp: number;
datetime: string;
info: any;
};
parseBorrowRateHistories(response: any, codes: any, since: any, limit: any): {};
parseBorrowRateHistory(response: any, code: any, since: any, limit: any): any;
fetchBorrowRateHistories(codes?: any, since?: Int, limit?: Int, params?: {}): Promise<{}>;
fetchBorrowRateHistory(code: string, since?: Int, limit?: Int, params?: {}): Promise<any>;
modifyMarginHelper(symbol: string, amount: any, type: any, params?: {}): Promise<{
info: any;
type: string;
amount: number;
code: string;
symbol: string;
status: string;
}>;
parseMarginModification(data: any, market?: Market): {
info: any;
type: string;
amount: number;
code: string;
symbol: string;
status: string;
};
reduceMargin(symbol: string, amount: any, params?: {}): Promise<{
info: any;
type: string;
amount: number;
code: string;
symbol: string;
status: string;
}>;
addMargin(symbol: string, amount: any, params?: {}): Promise<{
info: any;
type: string;
amount: number;
code: string;
symbol: string;
status: string;
}>;
fetchMarketLeverageTiers(symbol: string, params?: {}): Promise<any[]>;
parseMarketLeverageTiers(info: any, market?: Market): any[];
fetchBorrowInterest(code?: Str, symbol?: Str, since?: Int, limit?: Int, params?: {}): Promise<any>;
parseBorrowInterest(info: any, market?: Market): {
symbol: string;
marginMode: string;
currency: string;
interest: number;
interestRate: number;
amountBorrowed: number;
timestamp: number;
datetime: string;
info: any;
};
borrowCrossMargin(code: string, amount: any, params?: {}): Promise<{
id: any;
currency: string;
amount: number;
symbol: any;
timestamp: any;
datetime: any;
info: any;
}>;
repayCrossMargin(code: string, amount: any, params?: {}): Promise<{
id: any;
currency: string;
amount: number;
symbol: any;
timestamp: any;
datetime: any;
info: any;
}>;
parseMarginLoan(info: any, currency?: Currency): {
id: any;
currency: string;
amount: number;
symbol: any;
timestamp: any;
datetime: any;
info: any;
};
fetchOpenInterest(symbol: string, params?: {}): Promise<import("./base/types.js").OpenInterest>;
fetchOpenInterestHistory(symbol: string, timeframe?: string, since?: Int, limit?: Int, params?: {}): Promise<import("./base/types.js").OpenInterest[]>;
parseOpenInterest(interest: any, market?: Market): import("./base/types.js").OpenInterest;
setSandboxMode(enable: any): void;
fetchDepositWithdrawFees(codes?: Strings, params?: {}): Promise<{}>;
parseDepositWithdrawFees(response: any, codes?: any, currencyIdKey?: any): {};
fetchSettlementHistory(symbol?: Str, since?: Int, limit?: Int, params?: {}): Promise<any>;
parseSettlement(settlement: any, market: any): {
info: any;
symbol: string;
price: number;
timestamp: any;
datetime: any;
};
parseSettlements(settlements: any, market: any): any[];
fetchUnderlyingAssets(params?: {}): Promise<any>;
fetchGreeks(symbol: string, params?: {}): Promise<Greeks>;
parseGreeks(greeks: any, market?: Market): {
symbol: string;
timestamp: number;
datetime: string;
delta: number;
gamma: number;
theta: number;
vega: number;
rho: any;
bidSize: any;
askSize: any;
bidImpliedVolatility: number;
askImpliedVolatility: number;
markImpliedVolatility: number;
bidPrice: any;
askPrice: any;
markPrice: any;
lastPrice: any;
underlyingPrice: any;
info: any;
};
closePosition(symbol: string, side?: OrderSide, params?: {}): Promise<Order>;
handleErrors(httpCode: any, reason: any, url: any, method: any, headers: any, body: any, response: any, requestHeaders: any, requestBody: any): any;
}