yahooAPI: Yahoo Finance API

yahooAPIR Documentation

Yahoo Finance API

Description

Yahoo Finance API class inherits 'TDIConnection' to implement API requests.

Details

Yahoo Finance API provides a wide range of data that can be accessed via the below URL. The data returned is specified by the requested modules in the query string.

https://query2.finance.yahoo.com/v10/finance/quoteSummary/MSFT?modules=assetProfile

Available modules: - 'assetProfile', - 'summaryProfile', - 'summaryDetail', - 'esgScores', - 'price', - 'incomeStatementHistory', - 'incomeStatementHistoryQuarterly', - 'balanceSheetHistory', - 'balanceSheetHistoryQuarterly', - 'cashflowStatementHistory', - 'cashflowStatementHistoryQuarterly', - 'defaultKeyStatistics', - 'financialData', - 'calendarEvents', - 'secFilings', - 'recommendationTrend', - 'upgradeDowngradeHistory', - 'institutionOwnership', - 'fundOwnership', - 'majorDirectHolders', - 'majorHoldersBreakdown', - 'insiderTransactions', - 'insiderHolders', - 'netSharePurchaseActivity', - 'earnings', - 'earningsHistory', - 'earningsTrend', - 'industryTrend', - 'indexTrend', - 'sectorTrend'

Super classes

TDI::baseTDI -> TDI::TDIConnection -> yahooAPI

Methods

Public methods

Inherited methods

Method getInstrument()

Retrieve instrument details for the symbol.

Usage
yahooAPI$getInstrument(...)
Arguments
...

see TDIConnection

Returns

An object of class 'Instrument' with details.


Method getCashFlow()

Retrieve cash flow data for the symbol.

Usage
yahooAPI$getCashFlow(...)
Arguments
...

see TDIConnection

Returns

An object of class 'Instrument' with details.


Method getChart()

Retrieve historical prices for the symbol.

Usage
yahooAPI$getChart(...)
Arguments
...

see TDIConnection

Returns

An object of class 'Instrument' with historical prices.


n0Trader/TDI documentation built on July 30, 2023, 7:48 p.m.