UNPKG

@sharplygroup/xtb-api-js

Version:

A module for interacting with the XTB API

31 lines (30 loc) 1.4 kB
import { WebSocketManager } from "../utils/WebSocketManager"; import { ICommissionResponse, IMarginTradeResponse, IProfitCalculationResponse } from "../interfaces"; export declare class CalculationOperations { private readonly wsManager; constructor(wsManager: WebSocketManager); /** * Returns calculation of commission and rate of exchange. * @param {string} symbol - symbol * @param {number} volume - volume * @returns {Promise<ICommissionResponse>} */ getCommissionDef(symbol: string, volume: number): Promise<ICommissionResponse>; /** * Returns expected margin for given instrument and volume. * @param {string} symbol - symbol * @param {number} volume - volume * @returns {Promise<IMarginTradeResponse>} */ getMarginTrade(symbol: string, volume: number): Promise<IMarginTradeResponse>; /** * Calculates estimated profit for given deal data. * @param {number} closePrice - theoretical close price of order * @param {number} cmd - Operation code * @param {number} openPrice - theoretical open price of order * @param {string} symbol - symbol * @param {number} volume - volume * @returns {Promise<IProfitCalculationResponse>} */ getProfitCalculation(closePrice: number, cmd: number, openPrice: number, symbol: string, volume: number): Promise<IProfitCalculationResponse>; }