From b8fe684715fb2d1d5b915fe7296b0ea60b9e008e Mon Sep 17 00:00:00 2001 From: Nico Genz <34741282+RoXioTD@users.noreply.github.com> Date: Sat, 14 Aug 2021 10:29:04 +0200 Subject: [PATCH 01/23] docs: add insiderTransaction example --- docs/modules/quoteSummary.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/docs/modules/quoteSummary.md b/docs/modules/quoteSummary.md index 05cde5ba..4e58c533 100644 --- a/docs/modules/quoteSummary.md +++ b/docs/modules/quoteSummary.md @@ -634,7 +634,28 @@ await yahooFinance.quoteSummary('', { modules: [ "insiderHolders" ] }); ### insiderTransactions ```js -await yahooFinance.quoteSummary('', { modules: [ "insiderTransactions" ] }); +await yahooFinance.quoteSummary('PLTR', { modules: [ "insiderTransactions" ] }); + +{ + "insiderTransactions": { + "transactions": [ + { + "maxAge": 1, + "shares": 1915887, + "value": 42390086, + "filerUrl": "", + "transactionText": "Sale at price 21.82 - 22.48 per share.", + "filerName": "KARP ALEXANDER C.", + "filerRelation": "Chief Executive Officer", + "moneyText": "", + "startDate": "2021-07-23T00:00:00.000Z", + "ownership": "D" + }, + /* ... */ + ], + "maxAge": 1 + } +} ``` From fd8abdfa2f812a170cac1b86c678a179b9e8b9f2 Mon Sep 17 00:00:00 2001 From: Nico Genz <34741282+RoXioTD@users.noreply.github.com> Date: Sat, 14 Aug 2021 10:32:03 +0200 Subject: [PATCH 02/23] docs: add insiderHolders example --- docs/modules/quoteSummary.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/docs/modules/quoteSummary.md b/docs/modules/quoteSummary.md index 4e58c533..2b7c9fcc 100644 --- a/docs/modules/quoteSummary.md +++ b/docs/modules/quoteSummary.md @@ -625,7 +625,26 @@ await yahooFinance.quoteSummary('', { modules: [ "industryTrend" ] }); ### insiderHolders ```js -await yahooFinance.quoteSummary('', { modules: [ "insiderHolders" ] }); +await yahooFinance.quoteSummary('PLTR', { modules: [ "insiderHolders" ] }); + +{ + "insiderHolders": { + "holders": [ + { + "maxAge": 1, + "name": "KARP ALEXANDER C.", + "relation": "Chief Executive Officer", + "url": "", + "transactionDescription": "Sale", + "latestTransDate": "2021-07-23T00:00:00.000Z", + "positionDirect": 6432260, + "positionDirectDate": 1626998400 + }, + /* ... */ + ], + "maxAge": 1 + } +} ``` From 7296069612aca19db656fbcbf3402d53c0262223 Mon Sep 17 00:00:00 2001 From: Nico Genz <34741282+RoXioTD@users.noreply.github.com> Date: Sat, 14 Aug 2021 10:34:55 +0200 Subject: [PATCH 03/23] docs: add netSharePurchaseActivity example --- docs/modules/quoteSummary.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/modules/quoteSummary.md b/docs/modules/quoteSummary.md index 2b7c9fcc..7e131f2f 100644 --- a/docs/modules/quoteSummary.md +++ b/docs/modules/quoteSummary.md @@ -710,8 +710,24 @@ await yahooFinance.quoteSummary('', { modules: [ "majorHoldersBreakdown" ] }); ### netSharePurchaseActivity ```js -await yahooFinance.quoteSummary('', { modules: [ "netSharePurchaseActivity" ] }); +await yahooFinance.quoteSummary('PLTR', { modules: [ "netSharePurchaseActivity" ] }); +{ + "netSharePurchaseActivity": { + "maxAge": 1, + "period": "6m", + "buyInfoCount": 63, + "buyInfoShares": 271439668, + "buyPercentInsiderShares": 2.907, + "sellInfoCount": 77, + "sellInfoShares": 106877256, + "sellPercentInsiderShares": 1.145, + "netInfoCount": 140, + "netInfoShares": 164562413, + "netPercentInsiderShares": 1.763, + "totalInsiderShares": 257929376 + } +} ``` From e3f6aa4ea3db49d2027f37b792b738ed751d7031 Mon Sep 17 00:00:00 2001 From: Nico Genz <34741282+RoXioTD@users.noreply.github.com> Date: Sat, 14 Aug 2021 11:12:56 +0200 Subject: [PATCH 04/23] docs: add institutionOwnership example --- docs/modules/quoteSummary.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/modules/quoteSummary.md b/docs/modules/quoteSummary.md index 7e131f2f..38458b0c 100644 --- a/docs/modules/quoteSummary.md +++ b/docs/modules/quoteSummary.md @@ -683,8 +683,24 @@ await yahooFinance.quoteSummary('PLTR', { modules: [ "insiderTransactions" ] }); ### institutionOwnership ```js -await yahooFinance.quoteSummary('', { modules: [ "institutionOwnership" ] }); +await yahooFinance.quoteSummary('PLTR', { modules: [ "institutionOwnership" ] }); +{ + "institutionOwnership": { + "maxAge": 1, + "ownershipList": [ + { + "maxAge": 1, + "reportDate": "2021-06-30T00:00:00.000Z", + "organization": "Blackrock Inc.", + "pctHeld": 0.0274, + "position": 49399569, + "value": 1302172638 + }, + /* ... */ + ] + } +} ``` From 91f3fc20945fe610a76a279f2979cecdb94002bc Mon Sep 17 00:00:00 2001 From: Nico Genz <34741282+RoXioTD@users.noreply.github.com> Date: Sat, 14 Aug 2021 16:53:31 +0200 Subject: [PATCH 05/23] docs: add cashflowStatementHistoryQuarterly example --- docs/modules/quoteSummary.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/docs/modules/quoteSummary.md b/docs/modules/quoteSummary.md index 38458b0c..b7c93bbf 100644 --- a/docs/modules/quoteSummary.md +++ b/docs/modules/quoteSummary.md @@ -350,8 +350,35 @@ await yahooFinance.quoteSummary('KO', { modules: [ "cashflowStatementHistory" ] ### cashflowStatementHistoryQuarterly ```js -await yahooFinance.quoteSummary('PFE', { modules: [ "cashflowStatementHistoryQuarterly" ] }); +await yahooFinance.quoteSummary('PLTR', { modules: [ "cashflowStatementHistoryQuarterly" ] }); +{ + "cashflowStatementHistoryQuarterly": { + "cashflowStatements": [ + { + "maxAge": 1, + "endDate": "2021-06-30T00:00:00.000Z", + "netIncome": -138580000, + "depreciation": 4762000, + "changeToNetincome": 240489000, + "changeToAccountReceivables": -88363000, + "changeToLiabilities": 22811000, + "changeToOperatingActivities": -18369000, + "totalCashFromOperatingActivities": 22750000, + "capitalExpenditures": -697000, + "totalCashflowsFromInvestingActivities": -697000, + "netBorrowings": -200000000, + "otherCashflowsFromFinancingActivities": 762000, + "totalCashFromFinancingActivities": -31410000, + "effectOfExchangeRate": 701000, + "changeInCash": -8656000, + "issuanceOfStock": 167828000 + }, + /* ... */ + ], + "maxAge": 86400 + } +} ``` From ffd1d7a31b9939a1d5fb5c5fdf8d229511e1624b Mon Sep 17 00:00:00 2001 From: Nico Genz <34741282+RoXioTD@users.noreply.github.com> Date: Sat, 14 Aug 2021 16:55:21 +0200 Subject: [PATCH 06/23] docs: add fundOwnership example --- docs/modules/quoteSummary.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/modules/quoteSummary.md b/docs/modules/quoteSummary.md index b7c93bbf..690fed3c 100644 --- a/docs/modules/quoteSummary.md +++ b/docs/modules/quoteSummary.md @@ -589,8 +589,24 @@ await yahooFinance.quoteSummary('TSLA', { modules: [ "financialData" ] }); ### fundOwnership ```js -await yahooFinance.quoteSummary('', { modules: [ "fundOwnership" ] }); +await yahooFinance.quoteSummary('PLTR', { modules: [ "fundOwnership" ] }); +{ + "fundOwnership": { + "maxAge": 1, + "ownershipList": [ + { + "maxAge": 1, + "reportDate": "2021-06-30T00:00:00.000Z", + "organization": "ARK ETF Tr-ARK Innovation ETF", + "pctHeld": 0.0127, + "position": 22905465, + "value": 603788057 + }, + /* ... */ + ] + } +} ``` From a4240cef7bf2382d7a9069fee4f916f8d2e73d3e Mon Sep 17 00:00:00 2001 From: Nico Genz <34741282+RoXioTD@users.noreply.github.com> Date: Sat, 14 Aug 2021 16:58:03 +0200 Subject: [PATCH 07/23] docs: add incomeStatementHistory example --- docs/modules/quoteSummary.md | 37 +++++++++++++++++++++++++++++++++++- 1 file changed, 36 insertions(+), 1 deletion(-) diff --git a/docs/modules/quoteSummary.md b/docs/modules/quoteSummary.md index 690fed3c..fa7d7e7f 100644 --- a/docs/modules/quoteSummary.md +++ b/docs/modules/quoteSummary.md @@ -632,7 +632,42 @@ await yahooFinance.quoteSummary('', { modules: [ "fundProfile" ] }); ### incomeStatementHistory ```js -await yahooFinance.quoteSummary('', { modules: [ "incomeStatementHistory" ] }); +await yahooFinance.quoteSummary('PLTR', { modules: [ "incomeStatementHistory" ] }); + +{ + "incomeStatementHistory": { + "incomeStatementHistory": [ + { + "maxAge": 1, + "endDate": "2020-12-31T00:00:00.000Z", + "totalRevenue": 1092673000, + "costOfRevenue": 352547000, + "grossProfit": 740126000, + "researchDevelopment": 560660000, + "sellingGeneralAdministrative": 1352471000, + "nonRecurring": null, + "otherOperatingExpenses": null, + "totalOperatingExpenses": 2265678000, + "operatingIncome": -1173005000, + "totalOtherIncomeExpenseNet": -6022000, + "ebit": -1173005000, + "interestExpense": -14139000, + "incomeBeforeTax": -1179027000, + "incomeTaxExpense": -12636000, + "minorityInterest": null, + "netIncomeFromContinuingOps": -1166391000, + "discontinuedOperations": null, + "extraordinaryItems": null, + "effectOfAccountingCharges": null, + "otherItems": null, + "netIncome": -1166391000, + "netIncomeApplicableToCommonShares": -1166391000 + }, + /* ... */ + ], + "maxAge": 86400 + } +} ``` From 573f3a22d5dddf48177cd2c6894bb369c80deda3 Mon Sep 17 00:00:00 2001 From: Nico Genz <34741282+RoXioTD@users.noreply.github.com> Date: Sat, 14 Aug 2021 16:59:18 +0200 Subject: [PATCH 08/23] docs: add incomeStatementHistoryQuarterly example --- docs/modules/quoteSummary.md | 36 +++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/docs/modules/quoteSummary.md b/docs/modules/quoteSummary.md index fa7d7e7f..8f587a67 100644 --- a/docs/modules/quoteSummary.md +++ b/docs/modules/quoteSummary.md @@ -676,8 +676,42 @@ await yahooFinance.quoteSummary('PLTR', { modules: [ "incomeStatementHistory" ] ### incomeStatementHistoryQuarterly ```js -await yahooFinance.quoteSummary('', { modules: [ "incomeStatementHistoryQuarterly" ] }); +await yahooFinance.quoteSummary('PLTR', { modules: [ "incomeStatementHistoryQuarterly" ] }); +{ + "incomeStatementHistoryQuarterly": { + "incomeStatementHistory": [ + { + "maxAge": 1, + "endDate": "2021-06-30T00:00:00.000Z", + "totalRevenue": 375642000, + "costOfRevenue": 90926000, + "grossProfit": 284716000, + "researchDevelopment": 110524000, + "sellingGeneralAdministrative": 320340000, + "nonRecurring": null, + "otherOperatingExpenses": null, + "totalOperatingExpenses": 521790000, + "operatingIncome": -146148000, + "totalOtherIncomeExpenseNet": 1907000, + "ebit": -146148000, + "interestExpense": -590000, + "incomeBeforeTax": -144241000, + "incomeTaxExpense": -5661000, + "minorityInterest": null, + "netIncomeFromContinuingOps": -138580000, + "discontinuedOperations": null, + "extraordinaryItems": null, + "effectOfAccountingCharges": null, + "otherItems": null, + "netIncome": -138580000, + "netIncomeApplicableToCommonShares": -138580000 + }, + /* ... */ + ], + "maxAge": 86400 + } +} ``` From 4e999600a8feb8faf4f29aef8c2c8b153a1478e7 Mon Sep 17 00:00:00 2001 From: Nico Genz <34741282+RoXioTD@users.noreply.github.com> Date: Sat, 14 Aug 2021 17:00:33 +0200 Subject: [PATCH 09/23] docs: add indexTrend example --- docs/modules/quoteSummary.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/modules/quoteSummary.md b/docs/modules/quoteSummary.md index 8f587a67..9fa33ed5 100644 --- a/docs/modules/quoteSummary.md +++ b/docs/modules/quoteSummary.md @@ -719,8 +719,23 @@ await yahooFinance.quoteSummary('PLTR', { modules: [ "incomeStatementHistoryQuar ### indexTrend ```js -await yahooFinance.quoteSummary('', { modules: [ "indexTrend" ] }); +await yahooFinance.quoteSummary('PLTR', { modules: [ "indexTrend" ] }); +{ + "indexTrend": { + "maxAge": 1, + "symbol": "SP5", + "peRatio": 18.0569, + "pegRatio": 1.78265, + "estimates": [ + { + "period": "0q", + "growth": 0.52900004 + }, + /* ... */ + ] + } +} ``` From 807a6b7db9cf97efad3baad2dcebd320af0a0dd3 Mon Sep 17 00:00:00 2001 From: Nico Genz <34741282+RoXioTD@users.noreply.github.com> Date: Sat, 14 Aug 2021 17:02:29 +0200 Subject: [PATCH 10/23] docs: add industryTrend example --- docs/modules/quoteSummary.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/modules/quoteSummary.md b/docs/modules/quoteSummary.md index 9fa33ed5..104a2d44 100644 --- a/docs/modules/quoteSummary.md +++ b/docs/modules/quoteSummary.md @@ -743,8 +743,15 @@ await yahooFinance.quoteSummary('PLTR', { modules: [ "indexTrend" ] }); ### industryTrend ```js -await yahooFinance.quoteSummary('', { modules: [ "industryTrend" ] }); +await yahooFinance.quoteSummary('PLTR', { modules: [ "industryTrend" ] }); +{ + "industryTrend": { + "maxAge": 1, + "symbol": null, + "estimates": [] + } +} ``` From 7b8ab038c3748003ac2f6a7a09b333e093285a1f Mon Sep 17 00:00:00 2001 From: Nico Genz <34741282+RoXioTD@users.noreply.github.com> Date: Sat, 14 Aug 2021 17:04:11 +0200 Subject: [PATCH 11/23] docs: add majorDirectHolders example --- docs/modules/quoteSummary.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/modules/quoteSummary.md b/docs/modules/quoteSummary.md index 104a2d44..ddd83fd1 100644 --- a/docs/modules/quoteSummary.md +++ b/docs/modules/quoteSummary.md @@ -842,8 +842,14 @@ await yahooFinance.quoteSummary('PLTR', { modules: [ "institutionOwnership" ] }) ### majorDirectHolders ```js -await yahooFinance.quoteSummary('', { modules: [ "majorDirectHolders" ] }); +await yahooFinance.quoteSummary('KO', { modules: [ "majorDirectHolders" ] }); +{ + "majorDirectHolders": { + "holders": [], + "maxAge": 1 + } +} ``` From e68e4756be7ca9deb5decc44ed75099ae9c8ca2e Mon Sep 17 00:00:00 2001 From: Nico Genz <34741282+RoXioTD@users.noreply.github.com> Date: Sat, 14 Aug 2021 17:05:22 +0200 Subject: [PATCH 12/23] docs: add majorHoldersBreakdown example --- docs/modules/quoteSummary.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/modules/quoteSummary.md b/docs/modules/quoteSummary.md index ddd83fd1..44aec148 100644 --- a/docs/modules/quoteSummary.md +++ b/docs/modules/quoteSummary.md @@ -857,8 +857,17 @@ await yahooFinance.quoteSummary('KO', { modules: [ "majorDirectHolders" ] }); ### majorHoldersBreakdown ```js -await yahooFinance.quoteSummary('', { modules: [ "majorHoldersBreakdown" ] }); +await yahooFinance.quoteSummary('PLTR', { modules: [ "majorHoldersBreakdown" ] }); +{ + "majorHoldersBreakdown": { + "maxAge": 1, + "insidersPercentHeld": 0.00638, + "institutionsPercentHeld": 0.6853, + "institutionsFloatPercentHeld": 0.6897, + "institutionsCount": 3155 + } +} ``` From 3074a817981d2aceaedf4534bfd95d22b66b841f Mon Sep 17 00:00:00 2001 From: Nico Genz <34741282+RoXioTD@users.noreply.github.com> Date: Sat, 14 Aug 2021 17:07:03 +0200 Subject: [PATCH 13/23] docs: add quoteType example --- docs/modules/quoteSummary.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/docs/modules/quoteSummary.md b/docs/modules/quoteSummary.md index 44aec148..dc1c93ba 100644 --- a/docs/modules/quoteSummary.md +++ b/docs/modules/quoteSummary.md @@ -947,8 +947,25 @@ await yahooFinance.quoteSummary('', { modules: [ "price" ] }); ### quoteType ```js -await yahooFinance.quoteSummary('', { modules: [ "quoteType" ] }); +await yahooFinance.quoteSummary('PLTR', { modules: [ "quoteType" ] }); +{ + "quoteType": { + "exchange": "NYQ", + "quoteType": "EQUITY", + "symbol": "PLTR", + "underlyingSymbol": "PLTR", + "shortName": "Palantir Technologies Inc.", + "longName": "Palantir Technologies Inc.", + "firstTradeDateEpochUtc": "2020-09-30T13:30:00.000Z", + "timeZoneFullName": "America/New_York", + "timeZoneShortName": "EDT", + "uuid": "0ea79370-ee21-3603-b0a1-16f5e7b345f1", + "messageBoardId": "finmb_43580005", + "gmtOffSetMilliseconds": -14400000, + "maxAge": 1 + } +} ``` From d35de9b110800e3616a4e3507bb890222b6394f5 Mon Sep 17 00:00:00 2001 From: Nico Genz <34741282+RoXioTD@users.noreply.github.com> Date: Sat, 14 Aug 2021 17:08:03 +0200 Subject: [PATCH 14/23] docs: add recommendationTrend example --- docs/modules/quoteSummary.md | 39 ++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/docs/modules/quoteSummary.md b/docs/modules/quoteSummary.md index dc1c93ba..78e5edf1 100644 --- a/docs/modules/quoteSummary.md +++ b/docs/modules/quoteSummary.md @@ -975,6 +975,45 @@ await yahooFinance.quoteSummary('PLTR', { modules: [ "quoteType" ] }); ```js await yahooFinance.quoteSummary('', { modules: [ "recommendationTrend" ] }); +{ + "recommendationTrend": { + "trend": [ + { + "period": "0m", + "strongBuy": 0, + "buy": 0, + "hold": 0, + "sell": 0, + "strongSell": 2 + }, + { + "period": "-1m", + "strongBuy": 1, + "buy": 1, + "hold": 4, + "sell": 1, + "strongSell": 2 + }, + { + "period": "-2m", + "strongBuy": 1, + "buy": 1, + "hold": 2, + "sell": 1, + "strongSell": 2 + }, + { + "period": "-3m", + "strongBuy": 1, + "buy": 0, + "hold": 5, + "sell": 0, + "strongSell": 0 + } + ], + "maxAge": 86400 + } +} ``` From df8544e8445437f4f767c732d63e166fb0db0c64 Mon Sep 17 00:00:00 2001 From: Nico Genz <34741282+RoXioTD@users.noreply.github.com> Date: Sat, 14 Aug 2021 17:20:49 +0200 Subject: [PATCH 15/23] docs: add sectorTrend example --- docs/modules/quoteSummary.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/modules/quoteSummary.md b/docs/modules/quoteSummary.md index 78e5edf1..75097d43 100644 --- a/docs/modules/quoteSummary.md +++ b/docs/modules/quoteSummary.md @@ -1030,8 +1030,15 @@ await yahooFinance.quoteSummary('', { modules: [ "secFilings" ] }); ### sectorTrend ```js -await yahooFinance.quoteSummary('', { modules: [ "sectorTrend" ] }); +await yahooFinance.quoteSummary('PLTR', { modules: [ "sectorTrend" ] }); +{ + "sectorTrend": { + "maxAge": 1, + "symbol": null, + "estimates": [] + } +} ``` From 37dda6645c4ab788661c07ef187071eb5fed2108 Mon Sep 17 00:00:00 2001 From: Nico Genz <34741282+RoXioTD@users.noreply.github.com> Date: Sat, 14 Aug 2021 17:42:15 +0200 Subject: [PATCH 16/23] docs: add fundPerformance example --- docs/modules/quoteSummary.md | 77 +++++++++++++++++++++++++++++++++++- 1 file changed, 76 insertions(+), 1 deletion(-) diff --git a/docs/modules/quoteSummary.md b/docs/modules/quoteSummary.md index 75097d43..fe4030fd 100644 --- a/docs/modules/quoteSummary.md +++ b/docs/modules/quoteSummary.md @@ -614,8 +614,83 @@ await yahooFinance.quoteSummary('PLTR', { modules: [ "fundOwnership" ] }); ### fundPerformance ```js -await yahooFinance.quoteSummary('', { modules: [ "fundPerformance" ] }); +await yahooFinance.quoteSummary('URTH', { modules: [ "fundPerformance" ] }); +{ + "fundPerformance": { + "maxAge": 1, + "performanceOverview": { + "asOfDate": "2021-08-13T00:00:00.000Z", + "ytdReturnPct": 0.1744, + "oneYearTotalReturn": 0.32860002, + "threeYearTotalReturn": 0.1592 + }, + "performanceOverviewCat": {}, + "trailingReturns": { + "asOfDate": "2021-06-30T00:00:00.000Z", + "ytd": 0.1349, + "oneMonth": 0.015700001, + "threeMonth": 0.0766, + "oneYear": 0.39450002, + "threeYear": 0.153, + "fiveYear": 0.1505, + "tenYear": 0, + "lastBullMkt": 0, + "lastBearMkt": 0 + }, + "trailingReturnsNav": { + "ytd": 0.1322, + "oneMonth": 0.0138, + "threeMonth": 0.078200005, + "oneYear": 0.39240003, + "threeYear": 0.1529, + "fiveYear": 0.15100001, + "tenYear": 0 + }, + "trailingReturnsCat": { + "ytd": 0, + "oneMonth": 0, + "threeMonth": 0, + "oneYear": 0, + "threeYear": 0, + "fiveYear": 0, + "tenYear": 0, + "lastBullMkt": 0, + "lastBearMkt": 0 + }, + "annualTotalReturns": { + "returns": [ + { + "year": 2020, + "annualValue": 0.1608675 + }, + /* ... */ + ], + "returnsCat": [] + }, + "pastQuarterlyReturns": { + "returns": [] + }, + "riskOverviewStatistics": { + "riskStatistics": [ + { + "year": "5y", + "alpha": 0.34, + "beta": 1.01, + "meanAnnualReturn": 1.27, + "rSquared": 99.35, + "stdDev": 14.69, + "sharpeRatio": 0.96, + "treynorRatio": 13.84 + }, + /* ... */ + ] + }, + "riskOverviewStatisticsCat": { + "riskStatisticsCat": [] + } + } +} ``` From a24e95aba83e3a44c546f0a9f922a5fcea2018c1 Mon Sep 17 00:00:00 2001 From: Nico Genz <34741282+RoXioTD@users.noreply.github.com> Date: Sat, 14 Aug 2021 17:44:23 +0200 Subject: [PATCH 17/23] docs: add fundProfile example --- docs/modules/quoteSummary.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/modules/quoteSummary.md b/docs/modules/quoteSummary.md index fe4030fd..e17b1461 100644 --- a/docs/modules/quoteSummary.md +++ b/docs/modules/quoteSummary.md @@ -700,6 +700,30 @@ await yahooFinance.quoteSummary('URTH', { modules: [ "fundPerformance" ] }); ```js await yahooFinance.quoteSummary('', { modules: [ "fundProfile" ] }); +{ + "fundProfile": { + "maxAge": 1, + "styleBoxUrl": "https://s.yimg.com/lq/i/fi/3_0stylelargeeq2.gif", + "family": "iShares", + "categoryName": null, + "legalType": "Exchange Traded Fund", + "managementInfo": { + "managerName": null, + "managerBio": null + }, + "feesExpensesInvestment": { + "annualReportExpenseRatio": 0.0023999999, + "annualHoldingsTurnover": 0.07, + "totalNetAssets": 114910.49, + "projectionValues": {} + }, + "feesExpensesInvestmentCat": { + "totalNetAssets": 114910.49, + "projectionValuesCat": {} + }, + "brokerages": [] + } +} ``` From 69b7bb3119daccfd1b2f16777ad69de38fedfe34 Mon Sep 17 00:00:00 2001 From: Nico Genz <34741282+RoXioTD@users.noreply.github.com> Date: Sat, 14 Aug 2021 17:47:37 +0200 Subject: [PATCH 18/23] docs: add missing symbols in example request --- docs/modules/quoteSummary.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/modules/quoteSummary.md b/docs/modules/quoteSummary.md index e17b1461..6d4e0baa 100644 --- a/docs/modules/quoteSummary.md +++ b/docs/modules/quoteSummary.md @@ -698,7 +698,7 @@ await yahooFinance.quoteSummary('URTH', { modules: [ "fundPerformance" ] }); ### fundProfile ```js -await yahooFinance.quoteSummary('', { modules: [ "fundProfile" ] }); +await yahooFinance.quoteSummary('URTH', { modules: [ "fundProfile" ] }); { "fundProfile": { @@ -999,7 +999,7 @@ await yahooFinance.quoteSummary('PLTR', { modules: [ "netSharePurchaseActivity" ### price ```js -await yahooFinance.quoteSummary('', { modules: [ "price" ] }); +await yahooFinance.quoteSummary('TSLA', { modules: [ "price" ] }); { price: { @@ -1072,7 +1072,7 @@ await yahooFinance.quoteSummary('PLTR', { modules: [ "quoteType" ] }); ### recommendationTrend ```js -await yahooFinance.quoteSummary('', { modules: [ "recommendationTrend" ] }); +await yahooFinance.quoteSummary('PLTR', { modules: [ "recommendationTrend" ] }); { "recommendationTrend": { @@ -1192,7 +1192,7 @@ await yahooFinance.quoteSummary('AMZN', { modules: [ "summaryDetail" ] }); ### summaryProfile ```js -await yahooFinance.quoteSummary('', { modules: [ "summaryProfile" ] }); +await yahooFinance.quoteSummary('AMZN', { modules: [ "summaryProfile" ] }); { summaryProfile: { From 47ea7fbfa8a090496c6eec390f640254b8956a8a Mon Sep 17 00:00:00 2001 From: Nico Genz <34741282+RoXioTD@users.noreply.github.com> Date: Sat, 14 Aug 2021 20:28:24 +0200 Subject: [PATCH 19/23] docs: correct example response --- docs/modules/quoteSummary.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/modules/quoteSummary.md b/docs/modules/quoteSummary.md index 6d4e0baa..be10cc05 100644 --- a/docs/modules/quoteSummary.md +++ b/docs/modules/quoteSummary.md @@ -961,10 +961,10 @@ await yahooFinance.quoteSummary('PLTR', { modules: [ "majorHoldersBreakdown" ] } { "majorHoldersBreakdown": { "maxAge": 1, - "insidersPercentHeld": 0.00638, - "institutionsPercentHeld": 0.6853, - "institutionsFloatPercentHeld": 0.6897, - "institutionsCount": 3155 + "insidersPercentHeld": 0.12776, + "institutionsPercentHeld": 0.25067, + "institutionsFloatPercentHeld": 0.28738, + "institutionsCount": 879 } } From 8432ebf8d9ceeb6ca1fecd18404f4390f90267a6 Mon Sep 17 00:00:00 2001 From: Nico Genz <34741282+RoXioTD@users.noreply.github.com> Date: Sat, 14 Aug 2021 22:07:45 +0200 Subject: [PATCH 20/23] docs: correct defaultKeyStatistics example --- docs/modules/quoteSummary.md | 61 +++++++++++++++++++++--------------- 1 file changed, 35 insertions(+), 26 deletions(-) diff --git a/docs/modules/quoteSummary.md b/docs/modules/quoteSummary.md index be10cc05..69989819 100644 --- a/docs/modules/quoteSummary.md +++ b/docs/modules/quoteSummary.md @@ -386,34 +386,43 @@ await yahooFinance.quoteSummary('PLTR', { modules: [ "cashflowStatementHistoryQu ### defaultKeyStatistics ```js -await yahooFinance.quoteSummary('', { modules: [ "defaultKeyStatistics" ] }); +await yahooFinance.quoteSummary('PLTR', { modules: [ "defaultKeyStatistics" ] }); { - cashflowStatementHistoryQuarterly: { - cashflowStatements: [ - { - maxAge: 1, - endDate: 2020-09-27T00:00:00.000Z, - netIncome: 2194000000, - depreciation: 1258000000, - changeToNetincome: -511000000, - changeToLiabilities: 0, - changeToOperatingActivities: -851000000, - totalCashFromOperatingActivities: 2090000000, - capitalExpenditures: -525000000, - investments: 838000000, - otherCashflowsFromInvestingActivities: 173000000, - totalCashflowsFromInvestingActivities: 481000000, - netBorrowings: -618000000, - otherCashflowsFromFinancingActivities: -2251000000, - totalCashFromFinancingActivities: -2821000000, - effectOfExchangeRate: 31000000, - changeInCash: -218000000, - issuanceOfStock: 48000000 - }, - /* ... */ - ], - maxAge: 86400 + "defaultKeyStatistics": { + "maxAge": 1, + "priceHint": 2, + "enterpriseValue": 46541389824, + "forwardPE": 124.5, + "profitMargins": -0.95135003, + "floatShares": 1513962964, + "sharesOutstanding": 1805229952, + "sharesShort": 58395451, + "sharesShortPriorMonth": 68132010, + "sharesShortPreviousMonthDate": 1625011200, + "dateShortInterest": 1627603200, + "sharesPercentSharesOut": 0.0311, + "heldPercentInsiders": 0.12776, + "heldPercentInstitutions": 0.25067, + "shortRatio": 2.11, + "shortPercentOfFloat": 0.0359, + "impliedSharesOutstanding": 1880080000, + "category": null, + "bookValue": 1.068, + "priceToBook": 23.314608, + "fundFamily": null, + "legalType": null, + "lastFiscalYearEnd": 1609372800, + "nextFiscalYearEnd": 1672444800, + "mostRecentQuarter": 1625011200, + "netIncomeToCommon": -1263715968, + "trailingEps": -0.79, + "pegRatio": 3.58, + "lastSplitFactor": null, + "enterpriseToRevenue": 35.037, + "enterpriseToEbitda": -37.24, + "52WeekChange": 1.6210527, + "SandP52WeekChange": 0.32111573 } } From a131e1d842df0639039de865b920fa95142af090 Mon Sep 17 00:00:00 2001 From: Nico Genz <34741282+RoXioTD@users.noreply.github.com> Date: Sun, 15 Aug 2021 11:54:22 +0200 Subject: [PATCH 21/23] docs: align date format --- docs/modules/quoteSummary.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/modules/quoteSummary.md b/docs/modules/quoteSummary.md index 69989819..eae2283e 100644 --- a/docs/modules/quoteSummary.md +++ b/docs/modules/quoteSummary.md @@ -357,7 +357,7 @@ await yahooFinance.quoteSummary('PLTR', { modules: [ "cashflowStatementHistoryQu "cashflowStatements": [ { "maxAge": 1, - "endDate": "2021-06-30T00:00:00.000Z", + "endDate": new Date("2021-06-30T00:00:00.000Z"), "netIncome": -138580000, "depreciation": 4762000, "changeToNetincome": 240489000, @@ -606,7 +606,7 @@ await yahooFinance.quoteSummary('PLTR', { modules: [ "fundOwnership" ] }); "ownershipList": [ { "maxAge": 1, - "reportDate": "2021-06-30T00:00:00.000Z", + "reportDate": new Date("2021-06-30T00:00:00.000Z"), "organization": "ARK ETF Tr-ARK Innovation ETF", "pctHeld": 0.0127, "position": 22905465, @@ -629,14 +629,14 @@ await yahooFinance.quoteSummary('URTH', { modules: [ "fundPerformance" ] }); "fundPerformance": { "maxAge": 1, "performanceOverview": { - "asOfDate": "2021-08-13T00:00:00.000Z", + "asOfDate": new Date("2021-08-13T00:00:00.000Z"), "ytdReturnPct": 0.1744, "oneYearTotalReturn": 0.32860002, "threeYearTotalReturn": 0.1592 }, "performanceOverviewCat": {}, "trailingReturns": { - "asOfDate": "2021-06-30T00:00:00.000Z", + "asOfDate": new Date("2021-06-30T00:00:00.000Z"), "ytd": 0.1349, "oneMonth": 0.015700001, "threeMonth": 0.0766, @@ -747,7 +747,7 @@ await yahooFinance.quoteSummary('PLTR', { modules: [ "incomeStatementHistory" ] "incomeStatementHistory": [ { "maxAge": 1, - "endDate": "2020-12-31T00:00:00.000Z", + "endDate": new Date("2020-12-31T00:00:00.000Z"), "totalRevenue": 1092673000, "costOfRevenue": 352547000, "grossProfit": 740126000, @@ -791,7 +791,7 @@ await yahooFinance.quoteSummary('PLTR', { modules: [ "incomeStatementHistoryQuar "incomeStatementHistory": [ { "maxAge": 1, - "endDate": "2021-06-30T00:00:00.000Z", + "endDate": new Date("2021-06-30T00:00:00.000Z"), "totalRevenue": 375642000, "costOfRevenue": 90926000, "grossProfit": 284716000, @@ -878,7 +878,7 @@ await yahooFinance.quoteSummary('PLTR', { modules: [ "insiderHolders" ] }); "relation": "Chief Executive Officer", "url": "", "transactionDescription": "Sale", - "latestTransDate": "2021-07-23T00:00:00.000Z", + "latestTransDate": new Date("2021-07-23T00:00:00.000Z"), "positionDirect": 6432260, "positionDirectDate": 1626998400 }, @@ -909,7 +909,7 @@ await yahooFinance.quoteSummary('PLTR', { modules: [ "insiderTransactions" ] }); "filerName": "KARP ALEXANDER C.", "filerRelation": "Chief Executive Officer", "moneyText": "", - "startDate": "2021-07-23T00:00:00.000Z", + "startDate": new Date("2021-07-23T00:00:00.000Z"), "ownership": "D" }, /* ... */ @@ -933,7 +933,7 @@ await yahooFinance.quoteSummary('PLTR', { modules: [ "institutionOwnership" ] }) "ownershipList": [ { "maxAge": 1, - "reportDate": "2021-06-30T00:00:00.000Z", + "reportDate": new Date("2021-06-30T00:00:00.000Z"), "organization": "Blackrock Inc.", "pctHeld": 0.0274, "position": 49399569, @@ -1065,7 +1065,7 @@ await yahooFinance.quoteSummary('PLTR', { modules: [ "quoteType" ] }); "underlyingSymbol": "PLTR", "shortName": "Palantir Technologies Inc.", "longName": "Palantir Technologies Inc.", - "firstTradeDateEpochUtc": "2020-09-30T13:30:00.000Z", + "firstTradeDateEpochUtc": new Date("2020-09-30T13:30:00.000Z"), "timeZoneFullName": "America/New_York", "timeZoneShortName": "EDT", "uuid": "0ea79370-ee21-3603-b0a1-16f5e7b345f1", From 9539b182111a07be983488735eed252876fc5c0d Mon Sep 17 00:00:00 2001 From: Nico Genz Date: Sun, 15 Aug 2021 13:05:55 +0200 Subject: [PATCH 22/23] feat(#263): replace timestamps with date objects --- schema.json | 27 +++++++++++++++++---------- src/modules/quoteSummary-iface.ts | 20 ++++++++++---------- 2 files changed, 27 insertions(+), 20 deletions(-) diff --git a/schema.json b/schema.json index 608bffe0..2d204481 100644 --- a/schema.json +++ b/schema.json @@ -3970,13 +3970,13 @@ "yahooFinanceType": "number" }, "sharesShortPriorMonth": { - "yahooFinanceType": "number" + "yahooFinanceType": "date" }, "sharesShortPreviousMonthDate": { - "yahooFinanceType": "number" + "yahooFinanceType": "date" }, "dateShortInterest": { - "yahooFinanceType": "number" + "yahooFinanceType": "date" }, "sharesPercentSharesOut": { "yahooFinanceType": "number" @@ -4024,13 +4024,13 @@ ] }, "lastFiscalYearEnd": { - "yahooFinanceType": "number" + "yahooFinanceType": "date" }, "nextFiscalYearEnd": { - "yahooFinanceType": "number" + "yahooFinanceType": "date" }, "mostRecentQuarter": { - "yahooFinanceType": "number" + "yahooFinanceType": "date" }, "earningsQuarterlyGrowth": { "yahooFinanceType": "number" @@ -4072,7 +4072,7 @@ "yahooFinanceType": "number" }, "lastDividendDate": { - "yahooFinanceType": "number" + "yahooFinanceType": "date" }, "ytdReturn": { "yahooFinanceType": "number" @@ -4295,7 +4295,14 @@ "yahooFinanceType": "number|null" }, "quarter": { - "yahooFinanceType": "number|null" + "anyOf": [ + { + "yahooFinanceType": "date" + }, + { + "type": "null" + } + ] }, "period": { "type": "string" @@ -5338,13 +5345,13 @@ "yahooFinanceType": "number" }, "positionDirectDate": { - "yahooFinanceType": "number" + "yahooFinanceType": "date" }, "positionIndirect": { "yahooFinanceType": "number" }, "positionIndirectDate": { - "yahooFinanceType": "number" + "yahooFinanceType": "date" }, "positionSummaryDate": { "yahooFinanceType": "date" diff --git a/src/modules/quoteSummary-iface.ts b/src/modules/quoteSummary-iface.ts index fd9903e6..b1b1005a 100644 --- a/src/modules/quoteSummary-iface.ts +++ b/src/modules/quoteSummary-iface.ts @@ -183,9 +183,9 @@ export interface DefaultKeyStatistics { floatShares?: number; sharesOutstanding?: number; sharesShort?: number; - sharesShortPriorMonth?: number; - sharesShortPreviousMonthDate?: number; - dateShortInterest?: number; + sharesShortPriorMonth?: Date; + sharesShortPreviousMonthDate?: Date; + dateShortInterest?: Date; sharesPercentSharesOut?: number; heldPercentInsiders?: number; heldPercentInstitutions?: number; @@ -198,9 +198,9 @@ export interface DefaultKeyStatistics { priceToBook?: number; fundFamily: null | string; legalType: null | string; - lastFiscalYearEnd?: number; - nextFiscalYearEnd?: number; - mostRecentQuarter?: number; + lastFiscalYearEnd?: Date; + nextFiscalYearEnd?: Date; + mostRecentQuarter?: Date; earningsQuarterlyGrowth?: number; netIncomeToCommon?: number; trailingEps?: number; @@ -213,7 +213,7 @@ export interface DefaultKeyStatistics { "52WeekChange"?: number; SandP52WeekChange?: number; lastDividendValue?: number; - lastDividendDate?: number; + lastDividendDate?: Date; ytdReturn?: number; beta3Year?: number; totalAssets?: number; @@ -277,7 +277,7 @@ export interface EarningsHistoryHistory { epsEstimate: number | null; epsDifference: number | null; surprisePercent: number | null; - quarter: number | null; + quarter: Date | null; period: string; } @@ -565,9 +565,9 @@ export interface Holder { transactionDescription: string; latestTransDate: Date; positionDirect?: number; - positionDirectDate?: number; + positionDirectDate?: Date; positionIndirect?: number; - positionIndirectDate?: number; + positionIndirectDate?: Date; positionSummaryDate?: Date; } From 9e743d179f23bf4439ca7f2e6a74ea4ccd006d4f Mon Sep 17 00:00:00 2001 From: Nico Genz Date: Sun, 15 Aug 2021 13:26:55 +0200 Subject: [PATCH 23/23] docs(#263): update docs according to new date format --- docs/modules/quoteSummary.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/modules/quoteSummary.md b/docs/modules/quoteSummary.md index eae2283e..a1eaad7e 100644 --- a/docs/modules/quoteSummary.md +++ b/docs/modules/quoteSummary.md @@ -398,9 +398,9 @@ await yahooFinance.quoteSummary('PLTR', { modules: [ "defaultKeyStatistics" ] }) "floatShares": 1513962964, "sharesOutstanding": 1805229952, "sharesShort": 58395451, - "sharesShortPriorMonth": 68132010, - "sharesShortPreviousMonthDate": 1625011200, - "dateShortInterest": 1627603200, + "sharesShortPriorMonth": new Date("1972-02-28T13:33:30.000Z"), + "sharesShortPreviousMonthDate": new Date("2021-06-30T00:00:00.000Z"), + "dateShortInterest": new Date("2021-07-30T00:00:00.000Z"), "sharesPercentSharesOut": 0.0311, "heldPercentInsiders": 0.12776, "heldPercentInstitutions": 0.25067, @@ -412,9 +412,9 @@ await yahooFinance.quoteSummary('PLTR', { modules: [ "defaultKeyStatistics" ] }) "priceToBook": 23.314608, "fundFamily": null, "legalType": null, - "lastFiscalYearEnd": 1609372800, - "nextFiscalYearEnd": 1672444800, - "mostRecentQuarter": 1625011200, + "lastFiscalYearEnd": new Date("2020-12-31T00:00:00.000Z"), + "nextFiscalYearEnd": new Date("2022-12-31T00:00:00.000Z"), + "mostRecentQuarter": new Date("2021-06-30T00:00:00.000Z"), "netIncomeToCommon": -1263715968, "trailingEps": -0.79, "pegRatio": 3.58, @@ -485,13 +485,13 @@ await yahooFinance.quoteSummary('MSFT', { modules: [ "earningsHistory" ] }); earningsHistory: { history: [ { - maxAge: 1, - epsActual: 1.4, - epsEstimate: 1.26, - epsDifference: 0.14, - surprisePercent: 0.111, - quarter: 1585612800, - period: '-4q' // "-3q", "-2q", "-1q" + "maxAge": 1, + "epsActual": 10.3, + "epsEstimate": 1.46, + "epsDifference": 8.84, + "surprisePercent": 6.055, + "quarter": new Date("2020-06-30T00:00:00.000Z"), + "period": "-4q" // "-3q", "-2q", "-1q" }, /* ... */ ], @@ -880,7 +880,7 @@ await yahooFinance.quoteSummary('PLTR', { modules: [ "insiderHolders" ] }); "transactionDescription": "Sale", "latestTransDate": new Date("2021-07-23T00:00:00.000Z"), "positionDirect": 6432260, - "positionDirectDate": 1626998400 + "positionDirectDate": new Date("2021-07-23T00:00:00.000Z") }, /* ... */ ],