fix(quote): add cryptocurrency interface

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

Hide file tree

Showing 2 changed files with 339 additions and 3 deletions.
diff --git a/schema.json b/schema.json
@@ -2472,6 +2472,9 @@
         },
         {
           "$ref": "#/definitions/QuoteMutualfund"
+        },
+        {
+          "$ref": "#/definitions/QuoteCryptoCurrency"
         }
       ]
     },
@@ -2758,6 +2761,322 @@
       ],
       "type": "object"
     },
+    "QuoteCryptoCurrency": {
+      "additionalProperties": false,
+      "properties": {
+        "ask": {
+          "yahooFinanceType": "number"
+        },
+        "askSize": {
+          "yahooFinanceType": "number"
+        },
+        "averageDailyVolume10Day": {
+          "yahooFinanceType": "number"
+        },
+        "averageDailyVolume3Month": {
+          "yahooFinanceType": "number"
+        },
+        "bid": {
+          "yahooFinanceType": "number"
+        },
+        "bidSize": {
+          "yahooFinanceType": "number"
+        },
+        "bookValue": {
+          "yahooFinanceType": "number"
+        },
+        "circulatingSupply": {
+          "yahooFinanceType": "number"
+        },
+        "coinImageUrl": {
+          "type": "string"
+        },
+        "currency": {
+          "type": "string"
+        },
+        "displayName": {
+          "type": "string"
+        },
+        "dividendDate": {
+          "yahooFinanceType": "date"
+        },
+        "earningsTimestamp": {
+          "yahooFinanceType": "date"
+        },
+        "earningsTimestampEnd": {
+          "yahooFinanceType": "date"
+        },
+        "earningsTimestampStart": {
+          "yahooFinanceType": "date"
+        },
+        "epsCurrentYear": {
+          "yahooFinanceType": "number"
+        },
+        "epsForward": {
+          "yahooFinanceType": "number"
+        },
+        "epsTrailingTwelveMonths": {
+          "yahooFinanceType": "number"
+        },
+        "esgPopulated": {
+          "type": "boolean"
+        },
+        "exchange": {
+          "type": "string"
+        },
+        "exchangeDataDelayedBy": {
+          "yahooFinanceType": "number"
+        },
+        "exchangeTimezoneName": {
+          "type": "string"
+        },
+        "exchangeTimezoneShortName": {
+          "type": "string"
+        },
+        "fiftyDayAverage": {
+          "yahooFinanceType": "number"
+        },
+        "fiftyDayAverageChange": {
+          "yahooFinanceType": "number"
+        },
+        "fiftyDayAverageChangePercent": {
+          "yahooFinanceType": "number"
+        },
+        "fiftyTwoWeekHigh": {
+          "yahooFinanceType": "number"
+        },
+        "fiftyTwoWeekHighChange": {
+          "yahooFinanceType": "number"
+        },
+        "fiftyTwoWeekHighChangePercent": {
+          "yahooFinanceType": "number"
+        },
+        "fiftyTwoWeekLow": {
+          "yahooFinanceType": "number"
+        },
+        "fiftyTwoWeekLowChange": {
+          "yahooFinanceType": "number"
+        },
+        "fiftyTwoWeekLowChangePercent": {
+          "yahooFinanceType": "number"
+        },
+        "fiftyTwoWeekRange": {
+          "yahooFinanceType": "TwoNumberRange"
+        },
+        "financialCurrency": {
+          "type": "string"
+        },
+        "firstTradeDateMilliseconds": {
+          "yahooFinanceType": "DateInMs"
+        },
+        "forwardPE": {
+          "yahooFinanceType": "number"
+        },
+        "fromCurrency": {
+          "type": "string"
+        },
+        "fullExchangeName": {
+          "type": "string"
+        },
+        "gmtOffSetMilliseconds": {
+          "yahooFinanceType": "number"
+        },
+        "ipoExpectedDate": {
+          "yahooFinanceType": "date"
+        },
+        "language": {
+          "type": "string"
+        },
+        "lastMarket": {
+          "type": "string"
+        },
+        "longName": {
+          "type": "string"
+        },
+        "market": {
+          "type": "string"
+        },
+        "marketCap": {
+          "yahooFinanceType": "number"
+        },
+        "marketState": {
+          "enum": [
+            "REGULAR",
+            "CLOSED",
+            "PRE",
+            "PREPRE",
+            "POST",
+            "POSTPOST"
+          ],
+          "type": "string"
+        },
+        "messageBoardId": {
+          "type": "string"
+        },
+        "newListingDate": {
+          "yahooFinanceType": "date"
+        },
+        "postMarketChange": {
+          "yahooFinanceType": "number"
+        },
+        "postMarketChangePercent": {
+          "yahooFinanceType": "number"
+        },
+        "postMarketPrice": {
+          "yahooFinanceType": "number"
+        },
+        "postMarketTime": {
+          "yahooFinanceType": "date"
+        },
+        "preMarketChange": {
+          "yahooFinanceType": "number"
+        },
+        "preMarketChangePercent": {
+          "yahooFinanceType": "number"
+        },
+        "preMarketPrice": {
+          "yahooFinanceType": "number"
+        },
+        "preMarketTime": {
+          "yahooFinanceType": "number"
+        },
+        "priceEpsCurrentYear": {
+          "yahooFinanceType": "number"
+        },
+        "priceHint": {
+          "yahooFinanceType": "number"
+        },
+        "priceToBook": {
+          "yahooFinanceType": "number"
+        },
+        "quoteSourceName": {
+          "type": "string"
+        },
+        "quoteType": {
+          "const": "CRYPTOCURRENCY",
+          "type": "string"
+        },
+        "region": {
+          "type": "string"
+        },
+        "regularMarketChange": {
+          "yahooFinanceType": "number"
+        },
+        "regularMarketChangePercent": {
+          "yahooFinanceType": "number"
+        },
+        "regularMarketDayHigh": {
+          "yahooFinanceType": "number"
+        },
+        "regularMarketDayLow": {
+          "yahooFinanceType": "number"
+        },
+        "regularMarketDayRange": {
+          "yahooFinanceType": "TwoNumberRange"
+        },
+        "regularMarketOpen": {
+          "yahooFinanceType": "number"
+        },
+        "regularMarketPreviousClose": {
+          "yahooFinanceType": "number"
+        },
+        "regularMarketPrice": {
+          "yahooFinanceType": "number"
+        },
+        "regularMarketTime": {
+          "yahooFinanceType": "number"
+        },
+        "regularMarketVolume": {
+          "yahooFinanceType": "number"
+        },
+        "sharesOutstanding": {
+          "yahooFinanceType": "number"
+        },
+        "shortName": {
+          "type": "string"
+        },
+        "sourceInterval": {
+          "yahooFinanceType": "number"
+        },
+        "startDate": {
+          "yahooFinanceType": "date"
+        },
+        "symbol": {
+          "type": "string"
+        },
+        "toCurrency": {
+          "type": "string"
+        },
+        "tradeable": {
+          "type": "boolean"
+        },
+        "trailingAnnualDividendRate": {
+          "yahooFinanceType": "number"
+        },
+        "trailingAnnualDividendYield": {
+          "yahooFinanceType": "number"
+        },
+        "trailingPE": {
+          "yahooFinanceType": "number"
+        },
+        "trailingThreeMonthNavReturns": {
+          "yahooFinanceType": "number"
+        },
+        "trailingThreeMonthReturns": {
+          "yahooFinanceType": "number"
+        },
+        "triggerable": {
+          "type": "boolean"
+        },
+        "twoHundredDayAverage": {
+          "yahooFinanceType": "number"
+        },
+        "twoHundredDayAverageChange": {
+          "yahooFinanceType": "number"
+        },
+        "twoHundredDayAverageChangePercent": {
+          "yahooFinanceType": "number"
+        },
+        "volume24Hr": {
+          "yahooFinanceType": "number"
+        },
+        "volumeAllCurrencies": {
+          "yahooFinanceType": "number"
+        },
+        "ytdReturn": {
+          "yahooFinanceType": "number"
+        }
+      },
+      "required": [
+        "circulatingSupply",
+        "coinImageUrl",
+        "esgPopulated",
+        "exchange",
+        "exchangeDataDelayedBy",
+        "exchangeTimezoneName",
+        "exchangeTimezoneShortName",
+        "fromCurrency",
+        "fullExchangeName",
+        "gmtOffSetMilliseconds",
+        "language",
+        "lastMarket",
+        "market",
+        "marketState",
+        "priceHint",
+        "quoteType",
+        "region",
+        "shortName",
+        "sourceInterval",
+        "startDate",
+        "symbol",
+        "toCurrency",
+        "tradeable",
+        "triggerable",
+        "volume24Hr",
+        "volumeAllCurrencies"
+      ],
+      "type": "object"
+    },
     "QuoteEquity": {
       "additionalProperties": false,
       "properties": {

diff --git a/src/modules/quote.ts b/src/modules/quote.ts
@@ -7,9 +7,6 @@ import type {
 
 import type { DateInMs, TwoNumberRange } from "../lib/commonTypes";
 
-export type Quote = QuoteEquity | QuoteEtf | QuoteMutualfund;
-export type QuoteResponse = Quote[];
-
 export interface QuoteBase {
   language: string; // "en-US",
   region: string; // "US",
@@ -110,6 +107,26 @@ export interface QuoteMutualfund extends QuoteBase {
   quoteType: "MUTUALFUND";
 }
 
+export interface QuoteCryptoCurrency extends QuoteBase {
+  quoteType: "CRYPTOCURRENCY";
+  circulatingSupply: number;
+  fromCurrency: string; // 'BTC'
+  toCurrency: string; // 'USD=X'
+  lastMarket: string; // 'CoinMarketCap'
+  coinImageUrl: string; // 'https://s.yimg.com/uc/fin/img/reports-thumbnails/1.png'
+  volume24Hr: number; // 62631043072
+  volumeAllCurrencies: number; // 62631043072
+  startDate: Date; // new Date(1367103600 * 1000)
+}
+
+export type Quote =
+  | QuoteEquity
+  | QuoteEtf
+  | QuoteMutualfund
+  | QuoteCryptoCurrency;
+
+export type QuoteResponse = Quote[];
+
 export interface QuoteOptions {}
 
 const queryOptionsDefaults = {};