Roadmap

Status:

• [x] Implemented

• [ ] In progress

• Not implemented yet

Current list of commands and its equivalent functions in OpenBB Platform which serve as a reference point.

• Equity

  • [x] search() ref

    • search for a company by its stock ticker.

    • example: vf.equity.search()

  • [x] profile() ref

    • get general info of a company by its stock ticker.

    • example: vf.equity.profile(symbol=’SSI’)

  • Price

    • [x] historical() ref

      • retrieve historical price of a stock ticker.

      • example: vf.equity.price.historical(symbol=’SSI’)

    • [x] quote() ref

      • retrieve quote data of a stock ticker.

      • example: vf.equity.price.quote(symbol=’SSI’)

    • performance() ref

      • params: symbol, provider

      • example: vf.equity.price.performance(symbol=’SSI’)

  • Discovery:

    • [x] active() ref

      • get the most active stocks by trading value.

      • example: vf.equity.discovery.active()

    • [x] gainers() ref

      • get the most gainers stocks.

      • example: vf.equity.discovery.gainers()

    • [x] losers() ref

      • get the most losers stocks.

      • example: vf.equity.discovery.losers()

  • Calendar

    • [x] events()

      • get the historical events of a stock ticker.

      • example: vf.equity.calendar.events(symbol=’SSI’, limit=100)

    • dividend() ref

    • earnings() ref

    • splits() ref

  • Fundamental

    • [x] management() ref

      • get the key executives of a company via its stock ticker.

      • example: vf.equity.fundamental.management(symbol=’SSI’)

    • [x] ratios() ref

      • get the key financial ratios of a company.

      • example: vf.equity.fundamental.ratios(symbol=’SSI’)

    • [x] dividends() ref

      • get the historical dividends data of a company.

      • example: vf.equity.fundamental.dividends(symbol=’SSI’)

    • [x] income() ref

      • get the report on the income statement of a company.

      • example: vf.equity.fundamental.income(symbol=’SSI’)

    • [x] balance() ref

      • get the report on the balance sheet of a company.

      • example: vf.equity.fundamental.balance(symbol=’SSI’)

    • [x] cash() ref

      • get the report on the cash flow statement of a company.

      • example: vf.equity.fundamental.cash(symbol=’SSI’)

    • [] multiples() ref

      • params: symbol, provider

      • example: vf.equity.fundamental.multiples(symbol=’SSI’)

      • NOTE: 20240215 tcbs has only historical p/e, p/b, industry and index muliples data which are quite useless

  • Ownership

    • [x] insider_trading() ref

      • get the insider trading data of a company.

      • example: vf.equity.ownership.insider_trading(symbol=’SSI’)

    • [x] major_holders() ref

      • get the information about the company ownership.

      • example: vf.equity.ownership.major_holders(symbol=’SSI’)

    • [x] foreign_trading()

      • get the trading data of foreign entities for a specific stock ticker.

      • example: vf.equity.ownership.foreign_trading(symbol=’SSI’)

    • [x] prop_trading()

      • get the proprietary trading data, showing the interest of the domestic prop trading firms in a company.

      • example: vf.equity.ownership.prop_trading(symbol=’SSI’)

    • share_statistics() ref

      • params: symbol, provider

      • example: vf.equity.ownership.share_statistics(symbol=’SSI’)

  • Estimates

    • consensus() ref

    • price_target() ref

• Derivatives

  • Futures

    • [x] historical() ref

      • get historical price of a futures contract.

      • example: vf.derivatives.futures.historical(symbol=’VN30F1M’)

    • [x] quote() ref

      • get historical quote of a futures contract.

      • example: vf.derivatives.futures.quote(symbol=’VN30F2402’)

    • [x] search()

      • search for a futures contract. An empty query will return all available futures contracts.

      • example: vf.derivatives.futures.search()

  • Options

    • chains() ref

    • NOTE: 20240214 Vietnam has not supported options contract yet

• Mutual Funds ref

  • [x] search()

    • search for a mutual funds via its symbol.

    • example: vf.funds.search()

  • [x] historical()

    • get historical price of a mutual funds.

    • example: vf.funds.historical(symbol=’vesaf’)

  • [x] holdings()

    • get top holdings of a mutual funds.

    • example: vf.funds.holdings(symbol=’vesaf’)

• ETF

  • [x] search() ref

    • search for a ETF via its symbol.

    • example: vf.etf.search()

  • [x] historical() ref

    • get historical price of a ETF.

    • example: vf.etf.historical(symbol=’E1VFVN30’)

  • holdings() ref

    • get top holdings of an ETF.

    • example: vf.funds.holdings(symbol=’E1VFVN30’)

  • Discovery ref

    • [] active() ref

    • [] gainers() ref

    • [] losers() ref

• Index

  • [x] search() ref

    • search for an index via its symbol.

    • example: vf.index.search()

  • [x] constituents() ref

    • get the list of constituents of an index.

    • example: vf.index.constituents(symbol=’vn30’)

  • Price

    • [x] historical() ref

      • get the historical price of an index.

      • example: vf.index.historical(symbol=’vn30’)

      • note: only some index has data, e.g. dnse: vnindex, vn30, hnx, upcom; tcbs: vnindex, vn30, upcom

• Currency

  • search() ref

    • params: provider. Default: empty string to list all available currency pairs

    • example: vf.currency.search()

  • reference_rates() ref

    • params: symbol, provider. Default: empty string to list the current reference rate of all available currency pairs

    • example: vf.currency.reference_rates()

• FixedIncome ref

  • Note: 20240215 ssi has data, but almost useless, need to research on other data sources.

• News

  • [x] company() ref

    • get the news related to a company.

    • example: vf.news.company(symbol=’SSI’)