fix(quoteSummary): add cryptocurrency types

gadicc · Feb 26, 2021 · 0523d6d · 0523d6d
1 parent 53044d3
commit 0523d6d
Show file tree

Hide file tree

Showing 2 changed files with 83 additions and 13 deletions.
diff --git a/schema.json b/schema.json
@@ -58,6 +58,9 @@
         "country": {
           "type": "string"
         },
+        "description": {
+          "type": "string"
+        },
         "fax": {
           "type": "string"
         },
@@ -76,6 +79,9 @@
         "maxAge": {
           "yahooFinanceType": "number"
         },
+        "name": {
+          "type": "string"
+        },
         "overallRisk": {
           "yahooFinanceType": "number"
         },
@@ -88,6 +94,9 @@
         "shareHolderRightsRisk": {
           "yahooFinanceType": "number"
         },
+        "startDate": {
+          "yahooFinanceType": "date"
+        },
         "state": {
           "type": "string"
         },
@@ -100,7 +109,6 @@
       },
       "required": [
         "maxAge",
-        "longBusinessSummary",
         "companyOfficers"
       ],
       "type": "object"
@@ -2320,6 +2328,9 @@
         "averageDailyVolume3Month": {
           "yahooFinanceType": "number"
         },
+        "circulatingSupply": {
+          "yahooFinanceType": "number"
+        },
         "currency": {
           "type": "string"
         },
@@ -2342,7 +2353,10 @@
           ]
         },
         "lastMarket": {
-          "type": "null"
+          "type": [
+            "null",
+            "string"
+          ]
         },
         "longName": {
           "type": [
@@ -2442,6 +2456,12 @@
         },
         "underlyingSymbol": {
           "type": "null"
+        },
+        "volume24Hr": {
+          "yahooFinanceType": "number"
+        },
+        "volumeAllCurrencies": {
+          "yahooFinanceType": "number"
         }
       },
       "required": [
@@ -5040,6 +5060,9 @@
         "bidSize": {
           "yahooFinanceType": "number"
         },
+        "circulatingSupply": {
+          "yahooFinanceType": "number"
+        },
         "currency": {
           "type": "string"
         },
@@ -5074,10 +5097,16 @@
           "yahooFinanceType": "number"
         },
         "fromCurrency": {
-          "type": "null"
+          "type": [
+            "string",
+            "null"
+          ]
         },
         "lastMarket": {
-          "type": "null"
+          "type": [
+            "string",
+            "null"
+          ]
         },
         "marketCap": {
           "yahooFinanceType": "number"
@@ -5118,8 +5147,14 @@
         "regularMarketVolume": {
           "yahooFinanceType": "number"
         },
+        "startDate": {
+          "yahooFinanceType": "date"
+        },
         "toCurrency": {
-          "type": "null"
+          "type": [
+            "string",
+            "null"
+          ]
         },
         "totalAssets": {
           "yahooFinanceType": "number"
@@ -5142,6 +5177,12 @@
         "volume": {
           "yahooFinanceType": "number"
         },
+        "volume24Hr": {
+          "yahooFinanceType": "number"
+        },
+        "volumeAllCurrencies": {
+          "yahooFinanceType": "number"
+        },
         "yield": {
           "yahooFinanceType": "number"
         },
@@ -5155,11 +5196,11 @@
         "previousClose",
         "regularMarketPreviousClose",
         "currency",
+        "algorithm",
+        "tradeable",
         "fromCurrency",
         "toCurrency",
-        "lastMarket",
-        "algorithm",
-        "tradeable"
+        "lastMarket"
       ],
       "type": "object"
     },
@@ -5185,6 +5226,9 @@
         "country": {
           "type": "string"
         },
+        "description": {
+          "type": "string"
+        },
         "fax": {
           "type": "string"
         },
@@ -5200,12 +5244,18 @@
         "maxAge": {
           "yahooFinanceType": "number"
         },
+        "name": {
+          "type": "string"
+        },
         "phone": {
           "type": "string"
         },
         "sector": {
           "type": "string"
         },
+        "startDate": {
+          "yahooFinanceType": "date"
+        },
         "state": {
           "type": "string"
         },

diff --git a/src/modules/quoteSummary-iface.ts b/src/modules/quoteSummary-iface.ts
@@ -61,7 +61,7 @@ export interface AssetProfile {
   website?: string;
   industry?: string;
   sector?: string;
-  longBusinessSummary: string;
+  longBusinessSummary?: string;
   fullTimeEmployees?: number;
   companyOfficers: CompanyOfficer[];
   auditRisk?: number;
@@ -71,6 +71,9 @@ export interface AssetProfile {
   overallRisk?: number;
   governanceEpochDate?: Date;
   compensationAsOfEpochDate?: Date;
+  name?: string; // 'Bitcoin';
+  startDate?: Date; // new Date('2013-04-28')
+  description?: string; // 'Bitcoin (BTC) is a cryptocurrency...'
 }
 
 export interface CompanyOfficer {
@@ -668,14 +671,18 @@ export interface Price {
   shortName: string;
   longName: null | string;
 
-  lastMarket: null;
+  lastMarket: null | string;
   marketState: string;
   marketCap?: number;
 
+  // Crypto only?  Is Price actually Quote?  TODO after
   currency?: string;
   currencySymbol?: string;
   fromCurrency: string | null;
   toCurrency: string | null;
+  volume24Hr?: number;
+  volumeAllCurrencies?: number;
+  circulatingSupply?: number;
 }
 
 export interface QuoteType {
@@ -767,15 +774,22 @@ export interface SummaryDetail {
   trailingAnnualDividendRate?: number;
   trailingAnnualDividendYield?: number;
   currency: string;
-  fromCurrency: null;
-  toCurrency: null;
-  lastMarket: null;
   algorithm: null;
   tradeable: boolean;
   yield?: number;
   totalAssets?: number;
   navPrice?: number;
   ytdReturn?: number;
+
+  // crypto only (optional, or null in other types)
+  // TODO: how does Price / SummaryDetail compare? common base?
+  fromCurrency: string | null; // 'BTC'
+  toCurrency: string | null; // 'USD-X'
+  lastMarket: string | null; // 'CoinMarketCap'
+  volume24Hr?: number; // 62650314752
+  volumeAllCurrencies?: number; // 62650314752
+  circulatingSupply?: number; // 18638932
+  startDate?: Date; // new Date(1367107200 * 1000)
 }
 
 export interface SummaryProfile {
@@ -795,6 +809,12 @@ export interface SummaryProfile {
   fullTimeEmployees?: number;
   companyOfficers: any[];
   maxAge: number;
+
+  // seems like for cryptocurency only
+  // TODO: how does this relate to Quote type.  Common base?
+  name?: string; // 'Bitcoin'
+  startDate?: Date; // new Date('2013-04-28')
+  description?: string; // 'Bitcoin (BTC) is a cryptocurrency...'
 }
 
 export interface TopHoldings {