Class ForInvestCLI

constructor

• new ForInvestCLI(
      username?: string,
      password?: string,
      token?: string,
      company?: string,
      resource?: string,
      wssUrl?: string,
      appName?: string,
      environment?: APIEnvironment,
  ): ForInvestCLI

  Parameters

  • Optionalusername: string

    username of ForInvest CLI

  • Optionalpassword: string

    password of ForInvest CLI

  • Optionaltoken: string

    token of ForInvest CLI - if you have token you can use it, in this case you don't need to provide username and password

  • Optionalcompany: string

    company of ForInvest CLI

  • Optionalresource: string

    resource of ForInvest CLI

  • OptionalwssUrl: string

    wssUrl web socket url if you want to connect socket service

  • OptionalappName: string

    your application name

  • Optionalenvironment: APIEnvironment

  Returns ForInvestCLI

socket

akd

• get akd(): IAKDRepo

  Returns IAKDRepo

  akd servies

balanceSheet

• get balanceSheet(): IBalanceSheetRepo

  Returns IBalanceSheetRepo

  balancesheet services

broker

• get broker(): IBrokerController

  Returns IBrokerController

  broker controller

cashFlow

• get cashFlow(): ICashFlowRepo

  Returns ICashFlowRepo

  cash flow services

companyInfo

• get companyInfo(): ICompanyInfoRepo

  Returns ICompanyInfoRepo

  company info services

correlation

• get correlation(): typeof CorrelationRepo

  Returns typeof CorrelationRepo

  correlation services

definition

• get definition(): IDefinitionsController

  Returns IDefinitionsController

  definition controller

depth

• get depth(): IDepthRepo

  Returns IDepthRepo

  depth servies

economicCalendar

• get economicCalendar(): IEconomicCalendarRepo

  Returns IEconomicCalendarRepo

  economic calendar services

endOfDay

• get endOfDay(): IEndOfDayRepo

  Returns IEndOfDayRepo

  end of day services

field

• get field(): IFieldsController

  Returns IFieldsController

  fields controller

getToken

• get getToken(): string

  Returns string

  token

heatMap

• get heatMap(): IHeatMapRepo

  Returns IHeatMapRepo

  heat map services

holiday

• get holiday(): IHolidayRepo

  Returns IHolidayRepo

  holiday services

incomeStatements

• get incomeStatements(): IIncomeStatementsRepo

  Returns IIncomeStatementsRepo

  income statements services

indicator

• get indicator(): IIndicatorRepo

  Returns IIndicatorRepo

  indicator servies

intraday

• get intraday(): IIntradayRepo

  Returns IIntradayRepo

  intraday services

lastQuarterRatios

• get lastQuarterRatios(): ILastQuarterRatiosRepo

  Returns ILastQuarterRatiosRepo

  last quarter ratios services

liquidity

• get liquidity(): typeof LiquidityRepo

  Returns typeof LiquidityRepo

  liquidity services

montel

• get montel(): IMontelRepo

  Returns IMontelRepo

  montel services

news

• get news(): INewsRepo

  Returns INewsRepo

  news services

performanceCompare

• get performanceCompare(): typeof PerformanceCompareRepo

  Returns typeof PerformanceCompareRepo

  performance compare services

priceAnalysis

• get priceAnalysis(): IPriceAnalysisRepo

  Returns IPriceAnalysisRepo

  price analysis services

quarterRatios

• get quarterRatios(): IQuarterRatiosRepo

  Returns IQuarterRatiosRepo

  quarter ratios services

settlement

• get settlement(): ISettlementRepo

  Returns ISettlementRepo

  settlement servies

snapshot

• get snapshot(): ISnapshotRepo

  Returns ISnapshotRepo

  news services

socialMedia

• get socialMedia(): ISocialMediaRepo

  Returns ISocialMediaRepo

  social media servies

split

• get split(): ISplitRepo

  Returns ISplitRepo

  split services

tick

• get tick(): ITickRepo

  Returns ITickRepo

  intraday services

transaction

• get transaction(): ITransactionRepo

  Returns ITransactionRepo

  transaction services

connectToSocket

• connectToSocket(): Promise<IPubsubConnectorService>

  Returns Promise<IPubsubConnectorService>

  socket

initialize

• initialize(): Promise<void>

  Returns Promise<void>

  socket