Skip to content

Commit

Permalink
Add quote typebox module, migrate quoteCombine and move over options …
Browse files Browse the repository at this point in the history 
…type
  • Loading branch information
@eddie-atkinson
eddie-atkinson committed Jul 26, 2024
1 parent bade2e9 commit 6637896
Show file tree
Hide file tree
Showing 3 changed files with 282 additions and 328 deletions.
122 changes: 2 additions & 120 deletions src/modules/options.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,128 +6,10 @@ import type {
} from "../lib/moduleCommon.js";
import { Type, Static } from "@sinclair/typebox";

import {
YahooDateInMs,
YahooFinanceDate,
YahooNumber,
YahooTwoNumberRange,
} from "../lib/yahooFinanceTypes.js";

import { YahooFinanceDate, YahooNumber } from "../lib/yahooFinanceTypes.js";
import { QuoteBase } from "./quote.js";
import { Value } from "@sinclair/typebox/value";

const QuoteBase = Type.Object(
{
language: Type.String(), // "en-US",
region: Type.String(), // "US",
quoteType: Type.String(), // "EQUITY" | "ETF" | "MUTUALFUND";
typeDisp: Type.Optional(Type.String()), // "Equity", not always present.
quoteSourceName: Type.Optional(Type.String()), // "Delayed Quote",
triggerable: Type.Boolean(), // true,
currency: Type.Optional(Type.String()), // "USD",
// Seems to appear / disappear based not on symbol but network load (#445)
customPriceAlertConfidence: Type.Optional(Type.String()), // "HIGH" | "LOW"; TODO: anything else?
marketState: Type.Union([
Type.Literal("REGULAR"),
Type.Literal("CLOSED"),
Type.Literal("PRE"),
Type.Literal("PREPRE"),
Type.Literal("POST"),
Type.Literal("POSTPOST"),
]),
tradeable: Type.Boolean(), // false,
cryptoTradeable: Type.Optional(Type.Boolean()), // false
exchange: Type.String(), // "NMS",
shortName: Type.Optional(Type.String()), // "NVIDIA Corporation",
longName: Type.Optional(Type.String()), // "NVIDIA Corporation",
messageBoardId: Type.Optional(Type.String()), // "finmb_32307",
exchangeTimezoneName: Type.String(), // "America/New_York",
exchangeTimezoneShortName: Type.String(), // "EST",
gmtOffSetMilliseconds: YahooNumber, // -18000000,
market: Type.String(), // "us_market",
esgPopulated: Type.Boolean(), // false,
fiftyTwoWeekLowChange: Type.Optional(YahooNumber), // 362.96002,
fiftyTwoWeekLowChangePercent: Type.Optional(YahooNumber), // 2.0088556,
fiftyTwoWeekRange: Type.Optional(YahooTwoNumberRange), // "180.68 - 589.07" -> { low, high }
fiftyTwoWeekHighChange: Type.Optional(YahooNumber), // -45.429993,
fiftyTwoWeekHighChangePercent: Type.Optional(YahooNumber), // -0.07712155,
fiftyTwoWeekLow: Type.Optional(YahooNumber), // 180.68,
fiftyTwoWeekHigh: Type.Optional(YahooNumber), // 589.07,
fiftyTwoWeekChangePercent: Type.Optional(YahooNumber), // 22.604025
dividendDate: Type.Optional(YahooFinanceDate), // 1609200000,
// maybe always present on EQUITY?
earningsTimestamp: Type.Optional(YahooFinanceDate), // 1614200400,
earningsTimestampStart: Type.Optional(YahooFinanceDate), // 1614200400,
earningsTimestampEnd: Type.Optional(YahooFinanceDate), // 1614200400,
trailingAnnualDividendRate: Type.Optional(YahooNumber), // 0.64,
trailingPE: Type.Optional(YahooNumber), // 88.873634,
trailingAnnualDividendYield: Type.Optional(YahooNumber), // 0.0011709387,
epsTrailingTwelveMonths: Type.Optional(YahooNumber), // 6.117,
epsForward: Type.Optional(YahooNumber), // 11.68,
epsCurrentYear: Type.Optional(YahooNumber), // 9.72,
priceEpsCurrentYear: Type.Optional(YahooNumber), // 55.930042,
sharesOutstanding: Type.Optional(YahooNumber), // 619000000,
bookValue: Type.Optional(YahooNumber), // 24.772,
fiftyDayAverage: Type.Optional(YahooNumber), // 530.8828,
fiftyDayAverageChange: Type.Optional(YahooNumber), // 12.757202,
fiftyDayAverageChangePercent: Type.Optional(YahooNumber), // 0.024030166,
twoHundredDayAverage: Type.Optional(YahooNumber), // 515.8518,
twoHundredDayAverageChange: Type.Optional(YahooNumber), // 27.788208,
twoHundredDayAverageChangePercent: Type.Optional(YahooNumber), // 0.053868588,
marketCap: Type.Optional(YahooNumber), // 336513171456,
forwardPE: Type.Optional(YahooNumber), // 46.54452,
priceToBook: Type.Optional(YahooNumber), // 21.945745,
sourceInterval: YahooNumber, // 15,
exchangeDataDelayedBy: YahooNumber, // 0,
firstTradeDateMilliseconds: Type.Optional(YahooDateInMs), // 917015400000 -> Date
priceHint: YahooNumber, // 2,
postMarketChangePercent: Type.Optional(YahooNumber), // 0.093813874,
postMarketTime: Type.Optional(YahooFinanceDate), // 1612573179 -> new Date()
postMarketPrice: Type.Optional(YahooNumber), // 544.15,
postMarketChange: Type.Optional(YahooNumber), // 0.51000977,
regularMarketChange: Type.Optional(YahooNumber), // -2.9299927,
regularMarketChangePercent: Type.Optional(YahooNumber), // -0.53606904,
regularMarketTime: Type.Optional(YahooFinanceDate), // 1612558802 -> new Date()
regularMarketPrice: Type.Optional(YahooNumber), // 543.64,
regularMarketDayHigh: Type.Optional(YahooNumber), // 549.19,
regularMarketDayRange: Type.Optional(YahooTwoNumberRange), // "541.867 - 549.19" -> { low, high }
regularMarketDayLow: Type.Optional(YahooNumber), // 541.867,
regularMarketVolume: Type.Optional(YahooNumber), // 4228841,
regularMarketPreviousClose: Type.Optional(YahooNumber), // 546.57,
preMarketChange: Type.Optional(YahooNumber), // -2.9299927,
preMarketChangePercent: Type.Optional(YahooNumber), // -0.53606904,
preMarketTime: Type.Optional(YahooFinanceDate), // 1612558802 -> new Date()
preMarketPrice: Type.Optional(YahooNumber), // 543.64,
bid: Type.Optional(YahooNumber), // 543.84,
ask: Type.Optional(YahooNumber), // 544.15,
bidSize: Type.Optional(YahooNumber), // 18,
askSize: Type.Optional(YahooNumber), // 8,
fullExchangeName: Type.String(), // "NasdaqGS",
financialCurrency: Type.Optional(Type.String()), // "USD",
regularMarketOpen: Type.Optional(YahooNumber), // 549.0,
averageDailyVolume3Month: Type.Optional(YahooNumber), // 7475022,
averageDailyVolume10Day: Type.Optional(YahooNumber), // 5546385,
displayName: Type.Optional(Type.String()), // "NVIDIA",
symbol: Type.String(), // "NVDA"
underlyingSymbol: Type.Optional(Type.String()), // "LD.MI" (for LDO.MI, #363)
// only on ETF? not on EQUITY?
ytdReturn: Type.Optional(YahooNumber), // 0.31
trailingThreeMonthReturns: Type.Optional(YahooNumber), // 16.98
trailingThreeMonthNavReturns: Type.Optional(YahooNumber), // 17.08
ipoExpectedDate: Type.Optional(YahooFinanceDate), // "2020-08-13",
newListingDate: Type.Optional(YahooFinanceDate), // "2021-02-16",
nameChangeDate: Type.Optional(YahooFinanceDate),
prevName: Type.Optional(Type.String()),
averageAnalystRating: Type.Optional(Type.String()),
pageViewGrowthWeekly: Type.Optional(YahooNumber), // Since 2021-11-11 (#326)
openInterest: Type.Optional(YahooNumber), // SOHO (#248)
beta: Type.Optional(YahooNumber),
},
{
additionalProperties: Type.Any(),
title: "QuoteBase",
}
);

/*
* [TODO] Fields seen in a query but not in this module yet:
*
Expand Down
Loading

0 comments on commit 6637896

Please sign in to comment.