Skip to content

Latest commit

 

History

History
470 lines (458 loc) · 16.1 KB

dailyGainers.md

File metadata and controls

470 lines (458 loc) · 16.1 KB

trendingSymbols

Usage:

import yahooFinance from 'yahoo-finance2';
const queryOptions = { count: 5, region: 'US', lang: 'en-US' };
const result = await yahooFinance.dailyGainers(queryOptions);

Result:

{
  "id": "ec5bebb9-b7b2-4474-9e5c-3e258b61cbe6",
  "title": "Day Gainers",
  "description": "Discover the equities with the greatest gains in the trading day.",
  "canonicalName": "DAY_GAINERS",
  "criteriaMeta": {
    "size": 5,
    "offset": 0,
    "sortField": "percentchange",
    "sortType": "DESC",
    "quoteType": "EQUITY",
    "criteria": [
      {
        "field": "percentchange",
        "operators": [
          "GT"
        ],
        "values": [
          3
        ],
        "labelsSelected": [],
        "dependentValues": []
      },
      {
        "field": "region",
        "operators": [
          "EQ"
        ],
        "values": [],
        "labelsSelected": [
          52
        ],
        "dependentValues": []
      },
      {
        "field": "intradaymarketcap",
        "operators": [
          "EQ"
        ],
        "values": [],
        "labelsSelected": [
          1,
          2,
          3
        ],
        "dependentValues": []
      },
      {
        "field": "dayvolume",
        "operators": [
          "GT"
        ],
        "values": [
          15000
        ],
        "labelsSelected": [],
        "dependentValues": []
      }
    ],
    "topOperator": "AND"
  },
  "rawCriteria": "{\"offset\":0,\"size\":5,\"sortField\":\"percentchange\",\"sortType\":\"DESC\",\"quoteType\":\"EQUITY\",\"query\":{\"operator\":\"AND\",\"operands\":[{\"operator\":\"GT\",\"operands\":[\"percentchange\",3.0]},{\"operator\":\"eq\",\"operands\":[\"region\",\"us\"]},{\"operator\":\"or\",\"operands\":[{\"operator\":\"BTWN\",\"operands\":[\"intradaymarketcap\",2000000000,10000000000]},{\"operator\":\"BTWN\",\"operands\":[\"intradaymarketcap\",10000000000,100000000000]},{\"operator\":\"GT\",\"operands\":[\"intradaymarketcap\",100000000000]}]},{\"operator\":\"gt\",\"operands\":[\"dayvolume\",15000]}]}}",
  "start": 0,
  "count": 5,
  "total": 38,
  "quotes": [
    {
      "language": "en-US",
      "region": "US",
      "quoteType": "EQUITY",
      "typeDisp": "Equity",
      "quoteSourceName": "Delayed Quote",
      "triggerable": false,
      "customPriceAlertConfidence": "LOW",
      "lastCloseTevEbitLtm": -38.925724,
      "regularMarketChange": 0.059,
      "regularMarketTime": 1694022026,
      "regularMarketPrice": 0.06,
      "regularMarketDayHigh": 0.1,
      "regularMarketDayRange": "0.06 - 0.1",
      "regularMarketDayLow": 0.06,
      "regularMarketVolume": 75675,
      "regularMarketPreviousClose": 0.001,
      "market": "us_market",
      "messageBoardId": "finmb_39388687",
      "fullExchangeName": "Other OTC",
      "longName": "China Evergrande Group",
      "financialCurrency": "CNY",
      "regularMarketOpen": 0.07,
      "averageDailyVolume3Month": 6011,
      "averageDailyVolume10Day": 13298,
      "fiftyTwoWeekLowChange": 0.0598,
      "fiftyTwoWeekLowChangePercent": 299,
      "fiftyTwoWeekRange": "2.0E-4 - 0.1899",
      "fiftyTwoWeekHighChange": -0.1299,
      "fiftyTwoWeekHighChangePercent": -0.68404424,
      "fiftyTwoWeekChangePercent": -99.09091,
      "dividendDate": 1467936000,
      "currency": "USD",
      "trailingAnnualDividendRate": 0,
      "trailingAnnualDividendYield": 0,
      "marketState": "REGULAR",
      "epsTrailingTwelveMonths": -0.02,
      "sharesOutstanding": 13204299776,
      "bookValue": -49.653,
      "fiftyDayAverage": 0.00353,
      "fiftyDayAverageChange": 0.05647,
      "fiftyDayAverageChangePercent": 15.997167,
      "twoHundredDayAverage": 0.0192125,
      "twoHundredDayAverageChange": 0.0407875,
      "twoHundredDayAverageChangePercent": 2.1229668,
      "marketCap": 69454192640,
      "priceToBook": -0.0012083862,
      "sourceInterval": 15,
      "exchangeDataDelayedBy": 0,
      "exchangeTimezoneName": "America/New_York",
      "exchangeTimezoneShortName": "EDT",
      "gmtOffSetMilliseconds": -14400000,
      "esgPopulated": false,
      "tradeable": false,
      "cryptoTradeable": false,
      "firstTradeDateMilliseconds": 1273066200000,
      "priceHint": 4,
      "exchange": "PNK",
      "fiftyTwoWeekLow": 0.0002,
      "fiftyTwoWeekHigh": 0.1899,
      "shortName": "CHINA EVERGRANDE GROUP",
      "regularMarketChangePercent": 5900.0103,
      "displayName": "China Evergrande",
      "symbol": "EGRNF"
    },
    {
      "language": "en-US",
      "region": "US",
      "quoteType": "EQUITY",
      "typeDisp": "Equity",
      "quoteSourceName": "Delayed Quote",
      "triggerable": false,
      "customPriceAlertConfidence": "LOW",
      "lastCloseTevEbitLtm": -6.969699,
      "lastClosePriceToNNWCPerShare": -0.010227259877067203,
      "regularMarketChange": 0.030749992,
      "regularMarketTime": 1694021728,
      "regularMarketPrice": 0.16475,
      "regularMarketDayHigh": 0.1761,
      "regularMarketDayRange": "0.1534 - 0.1761",
      "regularMarketDayLow": 0.1534,
      "regularMarketVolume": 90550,
      "regularMarketPreviousClose": 0.134,
      "bid": 0,
      "ask": 0,
      "bidSize": 0,
      "askSize": 0,
      "market": "us_market",
      "messageBoardId": "finmb_29328657",
      "fullExchangeName": "Other OTC",
      "longName": "Country Garden Holdings Company Limited",
      "financialCurrency": "CNY",
      "regularMarketOpen": 0.1625,
      "averageDailyVolume3Month": 20080,
      "averageDailyVolume10Day": 81900,
      "fiftyTwoWeekLowChange": 0.06474999,
      "fiftyTwoWeekLowChangePercent": 0.6474999,
      "fiftyTwoWeekRange": "0.1 - 0.43",
      "fiftyTwoWeekHighChange": -0.26525003,
      "fiftyTwoWeekHighChangePercent": -0.6168605,
      "fiftyTwoWeekChangePercent": -51.851852,
      "currency": "USD",
      "trailingAnnualDividendRate": 0,
      "trailingAnnualDividendYield": 0,
      "marketState": "REGULAR",
      "epsTrailingTwelveMonths": -0.03,
      "sharesOutstanding": 27637000192,
      "bookValue": 5.669,
      "fiftyDayAverage": 0.1658,
      "fiftyDayAverageChange": -0.0010500103,
      "fiftyDayAverageChangePercent": -0.0063329935,
      "twoHundredDayAverage": 0.26685,
      "twoHundredDayAverageChange": -0.1021,
      "twoHundredDayAverageChangePercent": -0.38261196,
      "marketCap": 4553195520,
      "priceToBook": 0.029061561,
      "sourceInterval": 15,
      "exchangeDataDelayedBy": 0,
      "exchangeTimezoneName": "America/New_York",
      "exchangeTimezoneShortName": "EDT",
      "gmtOffSetMilliseconds": -14400000,
      "esgPopulated": false,
      "tradeable": false,
      "cryptoTradeable": false,
      "firstTradeDateMilliseconds": 1181136600000,
      "priceHint": 4,
      "exchange": "PNK",
      "fiftyTwoWeekLow": 0.1,
      "fiftyTwoWeekHigh": 0.43,
      "shortName": "COUNTRY GARDEN HLDGS CO LTD",
      "regularMarketChangePercent": 22.947754,
      "displayName": "Country Garden Holdings Company",
      "symbol": "CTRYF"
    },
    {
      "language": "en-US",
      "region": "US",
      "quoteType": "EQUITY",
      "typeDisp": "Equity",
      "quoteSourceName": "Nasdaq Real Time Price",
      "triggerable": true,
      "customPriceAlertConfidence": "HIGH",
      "lastCloseTevEbitLtm": 117.658623,
      "lastClosePriceToNNWCPerShare": -459.0150770954308,
      "regularMarketChange": 20.809998,
      "regularMarketTime": 1694024227,
      "regularMarketPrice": 116.1,
      "regularMarketDayHigh": 124.3299,
      "regularMarketDayRange": "112.13 - 124.3299",
      "regularMarketDayLow": 112.13,
      "regularMarketVolume": 1778309,
      "regularMarketPreviousClose": 95.29,
      "bid": 115.36,
      "ask": 116.21,
      "bidSize": 8,
      "askSize": 8,
      "market": "us_market",
      "messageBoardId": "finmb_1674636",
      "fullExchangeName": "NasdaqGS",
      "longName": "AeroVironment, Inc.",
      "financialCurrency": "USD",
      "regularMarketOpen": 113.16,
      "averageDailyVolume3Month": 183358,
      "averageDailyVolume10Day": 143500,
      "fiftyTwoWeekLowChange": 41.189995,
      "fiftyTwoWeekLowChangePercent": 0.54985976,
      "fiftyTwoWeekRange": "74.91 - 124.3299",
      "fiftyTwoWeekHighChange": -8.229904,
      "fiftyTwoWeekHighChangePercent": -0.06619409,
      "fiftyTwoWeekChangePercent": 7.465887,
      "earningsTimestamp": 1693945800,
      "currency": "USD",
      "earningsTimestampStart": 1701723600,
      "earningsTimestampEnd": 1702069200,
      "trailingAnnualDividendRate": 0,
      "trailingAnnualDividendYield": 0,
      "marketState": "REGULAR",
      "epsTrailingTwelveMonths": -7.12,
      "epsForward": 2.98,
      "epsCurrentYear": 2.6,
      "priceEpsCurrentYear": 44.653847,
      "sharesOutstanding": 26292100,
      "bookValue": 21.161,
      "fiftyDayAverage": 96.0714,
      "fiftyDayAverageChange": 20.028595,
      "fiftyDayAverageChangePercent": 0.20847614,
      "twoHundredDayAverage": 93.8046,
      "twoHundredDayAverageChange": 22.295395,
      "twoHundredDayAverageChangePercent": 0.23767911,
      "marketCap": 3052512768,
      "forwardPE": 38.959732,
      "priceToBook": 5.4865084,
      "sourceInterval": 15,
      "exchangeDataDelayedBy": 0,
      "exchangeTimezoneName": "America/New_York",
      "exchangeTimezoneShortName": "EDT",
      "gmtOffSetMilliseconds": -14400000,
      "esgPopulated": false,
      "tradeable": false,
      "cryptoTradeable": false,
      "firstTradeDateMilliseconds": 1169562600000,
      "priceHint": 2,
      "exchange": "NMS",
      "fiftyTwoWeekLow": 74.91,
      "fiftyTwoWeekHigh": 124.3299,
      "shortName": "AeroVironment, Inc.",
      "regularMarketChangePercent": 21.838594,
      "averageAnalystRating": "1.9 - Buy",
      "displayName": "AeroVironment",
      "symbol": "AVAV"
    },
    {
      "language": "en-US",
      "region": "US",
      "quoteType": "EQUITY",
      "typeDisp": "Equity",
      "quoteSourceName": "Delayed Quote",
      "triggerable": false,
      "customPriceAlertConfidence": "LOW",
      "lastCloseTevEbitLtm": -6.969699,
      "lastClosePriceToNNWCPerShare": -0.010751892814821473,
      "regularMarketChange": 0.6400001,
      "regularMarketTime": 1694023199,
      "regularMarketPrice": 3.94,
      "regularMarketDayHigh": 4.1,
      "regularMarketDayRange": "3.8 - 4.1",
      "regularMarketDayLow": 3.8,
      "regularMarketVolume": 64565,
      "regularMarketPreviousClose": 3.3,
      "bid": 0,
      "ask": 0,
      "bidSize": 0,
      "askSize": 0,
      "market": "us_market",
      "messageBoardId": "finmb_29328657",
      "fullExchangeName": "Other OTC",
      "longName": "Country Garden Holdings Company Limited",
      "financialCurrency": "CNY",
      "regularMarketOpen": 4.02,
      "averageDailyVolume3Month": 11522,
      "averageDailyVolume10Day": 50640,
      "fiftyTwoWeekLowChange": 1.54,
      "fiftyTwoWeekLowChangePercent": 0.64166665,
      "fiftyTwoWeekRange": "2.4 - 11.0",
      "fiftyTwoWeekHighChange": -7.06,
      "fiftyTwoWeekHighChangePercent": -0.64181817,
      "fiftyTwoWeekChangePercent": -52.034885,
      "dividendDate": 1661472000,
      "currency": "USD",
      "trailingAnnualDividendRate": 0,
      "trailingAnnualDividendYield": 0,
      "marketState": "REGULAR",
      "epsTrailingTwelveMonths": -0.86,
      "sharesOutstanding": 1105479936,
      "bookValue": 141.725,
      "fiftyDayAverage": 4.0494,
      "fiftyDayAverageChange": -0.109399796,
      "fiftyDayAverageChangePercent": -0.027016299,
      "twoHundredDayAverage": 6.6446,
      "twoHundredDayAverageChange": -2.7045999,
      "twoHundredDayAverageChangePercent": -0.4070373,
      "marketCap": 4355591168,
      "priceToBook": 0.027800316,
      "sourceInterval": 15,
      "exchangeDataDelayedBy": 0,
      "exchangeTimezoneName": "America/New_York",
      "exchangeTimezoneShortName": "EDT",
      "gmtOffSetMilliseconds": -14400000,
      "esgPopulated": false,
      "tradeable": false,
      "cryptoTradeable": false,
      "firstTradeDateMilliseconds": 1364995800000,
      "priceHint": 4,
      "exchange": "PNK",
      "fiftyTwoWeekLow": 2.4,
      "fiftyTwoWeekHigh": 11,
      "shortName": "COUNTRY GARDEN HLDGS CO LTD UNS",
      "regularMarketChangePercent": 19.393942,
      "symbol": "CTRYY"
    },
    {
      "language": "en-US",
      "region": "US",
      "quoteType": "EQUITY",
      "typeDisp": "Equity",
      "quoteSourceName": "Nasdaq Real Time Price",
      "triggerable": false,
      "customPriceAlertConfidence": "LOW",
      "lastCloseTevEbitLtm": -10.073021,
      "lastClosePriceToNNWCPerShare": -2.365476868583487,
      "regularMarketChange": 4.880001,
      "regularMarketTime": 1694024232,
      "regularMarketPrice": 35.27,
      "regularMarketDayHigh": 35.9199,
      "regularMarketDayRange": "30.24 - 35.9199",
      "regularMarketDayLow": 30.24,
      "regularMarketVolume": 6644840,
      "regularMarketPreviousClose": 30.39,
      "bid": 34.42,
      "ask": 34.49,
      "bidSize": 8,
      "askSize": 8,
      "market": "us_market",
      "messageBoardId": "finmb_8548197",
      "fullExchangeName": "NYSE",
      "longName": "Alteryx, Inc.",
      "financialCurrency": "USD",
      "regularMarketOpen": 30.3,
      "averageDailyVolume3Month": 1941287,
      "averageDailyVolume10Day": 1392550,
      "fiftyTwoWeekLowChange": 7.3500004,
      "fiftyTwoWeekLowChangePercent": 0.26325217,
      "fiftyTwoWeekRange": "27.92 - 70.63",
      "fiftyTwoWeekHighChange": -35.359997,
      "fiftyTwoWeekHighChangePercent": -0.5006371,
      "fiftyTwoWeekChangePercent": -51.715923,
      "earningsTimestamp": 1691442000,
      "currency": "USD",
      "earningsTimestampStart": 1698663540,
      "earningsTimestampEnd": 1699012800,
      "trailingAnnualDividendRate": 0,
      "trailingAnnualDividendYield": 0,
      "marketState": "REGULAR",
      "epsTrailingTwelveMonths": -4.53,
      "epsForward": 1.11,
      "epsCurrentYear": 0.66,
      "priceEpsCurrentYear": 53.439392,
      "sharesOutstanding": 63165400,
      "bookValue": 0.732,
      "fiftyDayAverage": 36.6076,
      "fiftyDayAverageChange": -1.3376007,
      "fiftyDayAverageChangePercent": -0.03653888,
      "twoHundredDayAverage": 46.90595,
      "twoHundredDayAverageChange": -11.635948,
      "twoHundredDayAverageChangePercent": -0.24806978,
      "marketCap": 2505997056,
      "forwardPE": 31.774775,
      "priceToBook": 48.18306,
      "sourceInterval": 15,
      "exchangeDataDelayedBy": 0,
      "exchangeTimezoneName": "America/New_York",
      "exchangeTimezoneShortName": "EDT",
      "gmtOffSetMilliseconds": -14400000,
      "esgPopulated": false,
      "tradeable": false,
      "cryptoTradeable": false,
      "firstTradeDateMilliseconds": 1490362200000,
      "priceHint": 2,
      "exchange": "NYQ",
      "fiftyTwoWeekLow": 27.92,
      "fiftyTwoWeekHigh": 70.63,
      "shortName": "Alteryx, Inc.",
      "regularMarketChangePercent": 16.057919,
      "averageAnalystRating": "2.3 - Buy",
      "displayName": "Alteryx",
      "symbol": "AYX"
    }
  ],
  "useRecords": false,
  "predefinedScr": true,
  "versionId": 9,
  "creationDate": 1473796102800,
  "lastUpdated": 1660940390625,
  "isPremium": false,
  "iconUrl": "https://s.yimg.com/cv/apiv2/fin/img/assets/predefined_screeners/trendingUp.png"
}

Note: The example output above does not cover all possible return results, which can vary by asset type and even time of day (trading period). For an exhausting list of everything we cover and that you might get back, please see the TypeScript interface in https://github.com/gadicc/node-yahoo-finance2/blob/devel/src/modules/trendingSymbols.ts

API

await yahooFinance.dailyGainers(queryOptions, moduleOptions);

Query

While testing, the highest count returned was 38. region does not seem to do anything when changed, always returns US

Query Options

Name Type Default Description
count number 5 The max amount of symbols that can be returned.
lang string "en-US"
region string The region/country. Will override the search country is provided.

Module Options

See Common Options.