Skip to content

Latest commit

 

History

History
563 lines (552 loc) · 19.2 KB

dailyGainers.md

File metadata and controls

563 lines (552 loc) · 19.2 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",
        "subField": null,
        "operators": [
          "GT"
        ],
        "values": [
          3
        ],
        "labelsSelected": [],
        "dependentValues": []
      },
      {
        "field": "region",
        "subField": null,
        "operators": [
          "EQ"
        ],
        "values": [],
        "labelsSelected": [
          53
        ],
        "dependentValues": []
      },
      {
        "field": "intradaymarketcap",
        "subField": null,
        "operators": [
          "EQ"
        ],
        "values": [],
        "labelsSelected": [
          1,
          2,
          3
        ],
        "dependentValues": []
      },
      {
        "field": "intradayprice",
        "subField": null,
        "operators": [
          "GTE"
        ],
        "values": [
          5
        ],
        "labelsSelected": [],
        "dependentValues": []
      },
      {
        "field": "dayvolume",
        "subField": null,
        "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\":\"gte\",\"operands\":[\"intradayprice\",5]},{\"operator\":\"gt\",\"operands\":[\"dayvolume\",15000]}]}}",
  "start": 0,
  "count": 5,
  "total": 63,
  "quotes": [
    {
      "language": "en-US",
      "region": "US",
      "quoteType": "EQUITY",
      "typeDisp": "Equity",
      "quoteSourceName": "Nasdaq Real Time Price",
      "triggerable": false,
      "customPriceAlertConfidence": "LOW",
      "lastClosePriceToNNWCPerShare": -0.07272650494604638,
      "currency": "USD",
      "priceHint": 2,
      "preMarketChange": -0.25,
      "preMarketTime": 1739355804,
      "preMarketPrice": 34.04,
      "regularMarketChange": 5.040001,
      "regularMarketTime": 1739307601,
      "regularMarketPrice": 34.29,
      "regularMarketDayHigh": 34.87,
      "regularMarketDayRange": "30.6 - 34.87",
      "regularMarketDayLow": 30.6,
      "regularMarketVolume": 6311997,
      "regularMarketPreviousClose": 29.25,
      "bid": 24.89,
      "ask": 39.65,
      "bidSize": 2,
      "askSize": 2,
      "market": "us_market",
      "messageBoardId": "finmb_403751487",
      "fullExchangeName": "NasdaqGM",
      "longName": "GDS Holdings Limited",
      "financialCurrency": "CNY",
      "regularMarketOpen": 30.71,
      "averageDailyVolume3Month": 1594537,
      "averageDailyVolume10Day": 2310650,
      "corporateActions": [],
      "fiftyTwoWeekLowChange": 28.44,
      "fiftyTwoWeekLowChangePercent": 4.8615384,
      "fiftyTwoWeekRange": "5.85 - 34.87",
      "fiftyTwoWeekHighChange": -0.579998,
      "fiftyTwoWeekHighChangePercent": -0.016633153,
      "fiftyTwoWeekChangePercent": 381.08554,
      "earningsTimestamp": 1732017600,
      "earningsTimestampStart": 1742819400,
      "earningsTimestampEnd": 1743165000,
      "earningsCallTimestampStart": 1732021200,
      "earningsCallTimestampEnd": 1732021200,
      "isEarningsDateEstimate": true,
      "trailingAnnualDividendRate": 0,
      "trailingAnnualDividendYield": 0,
      "marketState": "PRE",
      "epsTrailingTwelveMonths": -2.98,
      "epsForward": -0.6,
      "epsCurrentYear": -4.45382,
      "priceEpsCurrentYear": -7.699009,
      "sharesOutstanding": 188948992,
      "bookValue": 99.15,
      "fiftyDayAverage": 22.3176,
      "fiftyDayAverageChange": 11.972401,
      "fiftyDayAverageChangePercent": 0.5364556,
      "twoHundredDayAverage": 16.376024,
      "twoHundredDayAverageChange": 17.913977,
      "twoHundredDayAverageChangePercent": 1.0939149,
      "marketCap": 6479060992,
      "forwardPE": -57.149998,
      "priceToBook": 0.34583965,
      "sourceInterval": 15,
      "exchangeDataDelayedBy": 0,
      "exchangeTimezoneName": "America/New_York",
      "exchangeTimezoneShortName": "EST",
      "gmtOffSetMilliseconds": -18000000,
      "esgPopulated": false,
      "tradeable": false,
      "cryptoTradeable": false,
      "exchange": "NGM",
      "fiftyTwoWeekHigh": 34.87,
      "fiftyTwoWeekLow": 5.85,
      "averageAnalystRating": "1.6 - Buy",
      "shortName": "GDS Holdings Limited",
      "hasPrePostMarketData": true,
      "firstTradeDateMilliseconds": 1478093400000,
      "preMarketChangePercent": -0.7290755,
      "regularMarketChangePercent": 17.230774,
      "displayName": "GDS",
      "symbol": "GDS"
    },
    {
      "language": "en-US",
      "region": "US",
      "quoteType": "EQUITY",
      "typeDisp": "Equity",
      "quoteSourceName": "Nasdaq Real Time Price",
      "triggerable": false,
      "customPriceAlertConfidence": "LOW",
      "lastCloseTevEbitLtm": -5.626255,
      "lastClosePriceToNNWCPerShare": -7.025769086478919,
      "currency": "USD",
      "priceHint": 2,
      "preMarketChange": 0.17000008,
      "preMarketTime": 1739351764,
      "preMarketPrice": 23.92,
      "regularMarketChange": 2.6499996,
      "regularMarketTime": 1739307601,
      "regularMarketPrice": 23.75,
      "regularMarketDayHigh": 25.29,
      "regularMarketDayRange": "23.09 - 25.29",
      "regularMarketDayLow": 23.09,
      "regularMarketVolume": 6407972,
      "regularMarketPreviousClose": 21.1,
      "bid": 18.09,
      "ask": 23.77,
      "bidSize": 2,
      "askSize": 3,
      "market": "us_market",
      "messageBoardId": "finmb_133551169",
      "fullExchangeName": "NasdaqGM",
      "longName": "Travere Therapeutics, Inc.",
      "financialCurrency": "USD",
      "regularMarketOpen": 24.04,
      "averageDailyVolume3Month": 1294713,
      "averageDailyVolume10Day": 1507000,
      "corporateActions": [],
      "fiftyTwoWeekLowChange": 18.630001,
      "fiftyTwoWeekLowChangePercent": 3.638672,
      "fiftyTwoWeekRange": "5.12 - 25.29",
      "fiftyTwoWeekHighChange": -1.5400009,
      "fiftyTwoWeekHighChangePercent": -0.060893666,
      "fiftyTwoWeekChangePercent": 155.75757,
      "earningsTimestampStart": 1739444340,
      "earningsTimestampEnd": 1740484800,
      "earningsCallTimestampStart": 1730377800,
      "earningsCallTimestampEnd": 1730377800,
      "isEarningsDateEstimate": true,
      "trailingAnnualDividendRate": 0,
      "trailingAnnualDividendYield": 0,
      "marketState": "PRE",
      "epsTrailingTwelveMonths": -4.52,
      "epsForward": -1.22,
      "epsCurrentYear": -2.84305,
      "priceEpsCurrentYear": -8.353704,
      "sharesOutstanding": 87034304,
      "bookValue": -0.391,
      "fiftyDayAverage": 18.9772,
      "fiftyDayAverageChange": 4.7728004,
      "fiftyDayAverageChangePercent": 0.25150183,
      "twoHundredDayAverage": 13.131925,
      "twoHundredDayAverageChange": 10.618075,
      "twoHundredDayAverageChangePercent": 0.8085696,
      "marketCap": 2067064704,
      "forwardPE": -19.467213,
      "priceToBook": -60.741688,
      "sourceInterval": 15,
      "exchangeDataDelayedBy": 0,
      "exchangeTimezoneName": "America/New_York",
      "exchangeTimezoneShortName": "EST",
      "gmtOffSetMilliseconds": -18000000,
      "prevName": "Retrophin, Inc.",
      "nameChangeDate": "2025-02-11T00:00:00.000Z",
      "esgPopulated": false,
      "tradeable": false,
      "cryptoTradeable": false,
      "exchange": "NGM",
      "fiftyTwoWeekHigh": 25.29,
      "fiftyTwoWeekLow": 5.12,
      "averageAnalystRating": "1.4 - Strong Buy",
      "shortName": "Travere Therapeutics, Inc.",
      "hasPrePostMarketData": true,
      "firstTradeDateMilliseconds": 1352385000000,
      "preMarketChangePercent": 0.7157898,
      "regularMarketChangePercent": 12.559239,
      "displayName": "Travere Therapeutics",
      "symbol": "TVTX"
    },
    {
      "language": "en-US",
      "region": "US",
      "quoteType": "EQUITY",
      "typeDisp": "Equity",
      "quoteSourceName": "Delayed Quote",
      "triggerable": false,
      "customPriceAlertConfidence": "LOW",
      "lastCloseTevEbitLtm": -5.551306,
      "lastClosePriceToNNWCPerShare": 21.32741682814225,
      "currency": "USD",
      "priceHint": 2,
      "preMarketChange": 0,
      "preMarketTime": 1739355310,
      "preMarketPrice": 42.53,
      "regularMarketChange": 4.28,
      "regularMarketTime": 1739307602,
      "regularMarketPrice": 42.53,
      "regularMarketDayHigh": 44.2803,
      "regularMarketDayRange": "38.89 - 44.2803",
      "regularMarketDayLow": 38.89,
      "regularMarketVolume": 2710042,
      "regularMarketPreviousClose": 38.25,
      "bid": 17.11,
      "ask": 0,
      "bidSize": 9,
      "askSize": 10,
      "market": "us_market",
      "messageBoardId": "finmb_1796230042",
      "fullExchangeName": "NYSE",
      "longName": "Biohaven Ltd.",
      "financialCurrency": "USD",
      "regularMarketOpen": 40.8,
      "averageDailyVolume3Month": 965027,
      "averageDailyVolume10Day": 635560,
      "corporateActions": [],
      "fiftyTwoWeekLowChange": 15.73,
      "fiftyTwoWeekLowChangePercent": 0.5869403,
      "fiftyTwoWeekRange": "26.8 - 62.21",
      "fiftyTwoWeekHighChange": -19.68,
      "fiftyTwoWeekHighChangePercent": -0.31634787,
      "fiftyTwoWeekChangePercent": -18.82428,
      "earningsTimestampStart": 1691065800,
      "earningsTimestampEnd": 1691411400,
      "trailingAnnualDividendRate": 0,
      "trailingAnnualDividendYield": 0,
      "marketState": "PRE",
      "epsTrailingTwelveMonths": -9.37,
      "epsForward": -6.32,
      "epsCurrentYear": -8.33319,
      "priceEpsCurrentYear": -5.103688,
      "sharesOutstanding": 101122000,
      "bookValue": 3.33,
      "fiftyDayAverage": 39.4694,
      "fiftyDayAverageChange": 3.0606003,
      "fiftyDayAverageChangePercent": 0.077543624,
      "twoHundredDayAverage": 40.7594,
      "twoHundredDayAverageChange": 1.7705994,
      "twoHundredDayAverageChangePercent": 0.04344027,
      "marketCap": 4300718592,
      "forwardPE": -6.72943,
      "priceToBook": 12.771771,
      "sourceInterval": 15,
      "exchangeDataDelayedBy": 0,
      "exchangeTimezoneName": "America/New_York",
      "exchangeTimezoneShortName": "EST",
      "gmtOffSetMilliseconds": -18000000,
      "prevName": "Biohaven Research Ltd.",
      "nameChangeDate": "2025-02-11T00:00:00.000Z",
      "esgPopulated": false,
      "tradeable": false,
      "cryptoTradeable": false,
      "exchange": "NYQ",
      "fiftyTwoWeekHigh": 62.21,
      "fiftyTwoWeekLow": 26.8,
      "averageAnalystRating": "1.3 - Strong Buy",
      "shortName": "Biohaven Ltd.",
      "hasPrePostMarketData": true,
      "firstTradeDateMilliseconds": 1663939800000,
      "preMarketChangePercent": 0,
      "regularMarketChangePercent": 11.1895,
      "displayName": "Biohaven",
      "symbol": "BHVN"
    },
    {
      "language": "en-US",
      "region": "US",
      "quoteType": "EQUITY",
      "typeDisp": "Equity",
      "quoteSourceName": "Nasdaq Real Time Price",
      "triggerable": false,
      "customPriceAlertConfidence": "LOW",
      "lastCloseTevEbitLtm": 13.480123,
      "lastClosePriceToNNWCPerShare": 6.383158179326566,
      "currency": "USD",
      "priceHint": 2,
      "preMarketChange": -0.9399986,
      "preMarketTime": 1739356047,
      "preMarketPrice": 53.61,
      "regularMarketChange": 4.55,
      "regularMarketTime": 1739307602,
      "regularMarketPrice": 54.55,
      "regularMarketDayHigh": 54.65,
      "regularMarketDayRange": "49.6875 - 54.65",
      "regularMarketDayLow": 49.6875,
      "regularMarketVolume": 3725530,
      "regularMarketPreviousClose": 50,
      "bid": 0,
      "ask": 53.7,
      "bidSize": 11,
      "askSize": 8,
      "market": "us_market",
      "messageBoardId": "finmb_27816540",
      "fullExchangeName": "NYSE",
      "longName": "New Oriental Education & Technology Group Inc.",
      "financialCurrency": "USD",
      "regularMarketOpen": 50.3,
      "averageDailyVolume3Month": 1846516,
      "averageDailyVolume10Day": 1542140,
      "corporateActions": [],
      "fiftyTwoWeekLowChange": 10.09,
      "fiftyTwoWeekLowChangePercent": 0.22694558,
      "fiftyTwoWeekRange": "44.46 - 98.2",
      "fiftyTwoWeekHighChange": -43.649998,
      "fiftyTwoWeekHighChangePercent": -0.444501,
      "fiftyTwoWeekChangePercent": -45.18746,
      "dividendDate": "2024-09-26T00:00:00.000Z",
      "earningsTimestamp": 1737451126,
      "earningsTimestampStart": 1745325000,
      "earningsTimestampEnd": 1745843400,
      "earningsCallTimestampStart": 1737464400,
      "earningsCallTimestampEnd": 1737464400,
      "isEarningsDateEstimate": true,
      "trailingAnnualDividendRate": 0,
      "trailingPE": 23.717392,
      "trailingAnnualDividendYield": 0,
      "marketState": "PRE",
      "epsTrailingTwelveMonths": 2.3,
      "epsForward": 4.32,
      "epsCurrentYear": 2.9401,
      "priceEpsCurrentYear": 18.553791,
      "sharesOutstanding": 163528992,
      "bookValue": 22.919,
      "fiftyDayAverage": 57.604,
      "fiftyDayAverageChange": -3.0540009,
      "fiftyDayAverageChangePercent": -0.053017166,
      "twoHundredDayAverage": 67.702,
      "twoHundredDayAverageChange": -13.152004,
      "twoHundredDayAverageChangePercent": -0.19426315,
      "marketCap": 8920506368,
      "forwardPE": 12.627315,
      "priceToBook": 2.3801212,
      "sourceInterval": 15,
      "exchangeDataDelayedBy": 0,
      "exchangeTimezoneName": "America/New_York",
      "exchangeTimezoneShortName": "EST",
      "gmtOffSetMilliseconds": -18000000,
      "esgPopulated": false,
      "tradeable": false,
      "cryptoTradeable": false,
      "exchange": "NYQ",
      "fiftyTwoWeekHigh": 98.2,
      "fiftyTwoWeekLow": 44.46,
      "shortName": "New Oriental Education & Techno",
      "hasPrePostMarketData": true,
      "firstTradeDateMilliseconds": 1158327000000,
      "preMarketChangePercent": -1.7231872,
      "regularMarketChangePercent": 9.1,
      "displayName": "New Oriental Education & Technology",
      "symbol": "EDU"
    },
    {
      "language": "en-US",
      "region": "US",
      "quoteType": "EQUITY",
      "typeDisp": "Equity",
      "quoteSourceName": "Delayed Quote",
      "triggerable": false,
      "customPriceAlertConfidence": "LOW",
      "lastCloseTevEbitLtm": 9.192283,
      "lastClosePriceToNNWCPerShare": -0.316560279064587,
      "currency": "USD",
      "priceHint": 2,
      "preMarketChange": 0.27999973,
      "preMarketTime": 1739351390,
      "preMarketPrice": 15,
      "regularMarketChange": 1.18,
      "regularMarketTime": 1739307602,
      "regularMarketPrice": 14.72,
      "regularMarketDayHigh": 14.77,
      "regularMarketDayRange": "14.28 - 14.77",
      "regularMarketDayLow": 14.28,
      "regularMarketVolume": 917233,
      "regularMarketPreviousClose": 13.54,
      "bid": 0,
      "ask": 0,
      "bidSize": 9,
      "askSize": 11,
      "market": "us_market",
      "messageBoardId": "finmb_413394",
      "fullExchangeName": "NYSE",
      "longName": "TIM S.A.",
      "financialCurrency": "BRL",
      "regularMarketOpen": 14.33,
      "averageDailyVolume3Month": 538510,
      "averageDailyVolume10Day": 708460,
      "corporateActions": [],
      "fiftyTwoWeekLowChange": 3.4000006,
      "fiftyTwoWeekLowChangePercent": 0.3003534,
      "fiftyTwoWeekRange": "11.32 - 19.14",
      "fiftyTwoWeekHighChange": -4.419999,
      "fiftyTwoWeekHighChangePercent": -0.23092996,
      "fiftyTwoWeekChangePercent": -26.85035,
      "dividendDate": "2025-01-30T00:00:00.000Z",
      "earningsTimestamp": 1739214000,
      "earningsTimestampStart": 1746442740,
      "earningsTimestampEnd": 1746792000,
      "earningsCallTimestampStart": 1739278800,
      "earningsCallTimestampEnd": 1739278800,
      "isEarningsDateEstimate": true,
      "trailingAnnualDividendRate": 0,
      "trailingPE": 12.912281,
      "dividendRate": 0.94,
      "trailingAnnualDividendYield": 0,
      "dividendYield": 6.95,
      "marketState": "PRE",
      "epsTrailingTwelveMonths": 1.14,
      "epsForward": 1.46,
      "epsCurrentYear": 1.42078,
      "priceEpsCurrentYear": 10.360507,
      "sharesOutstanding": 484120992,
      "bookValue": 10.326,
      "fiftyDayAverage": 12.6338,
      "fiftyDayAverageChange": 2.0862007,
      "fiftyDayAverageChangePercent": 0.16512853,
      "twoHundredDayAverage": 14.87225,
      "twoHundredDayAverageChange": -0.15224934,
      "twoHundredDayAverageChangePercent": -0.010237142,
      "marketCap": 7126261248,
      "forwardPE": 10.082191,
      "priceToBook": 1.4255278,
      "sourceInterval": 15,
      "exchangeDataDelayedBy": 0,
      "exchangeTimezoneName": "America/New_York",
      "exchangeTimezoneShortName": "EST",
      "gmtOffSetMilliseconds": -18000000,
      "prevName": "TIM Participações S.A.",
      "nameChangeDate": "2025-02-11T00:00:00.000Z",
      "esgPopulated": false,
      "tradeable": false,
      "cryptoTradeable": false,
      "exchange": "NYQ",
      "fiftyTwoWeekHigh": 19.14,
      "fiftyTwoWeekLow": 11.32,
      "averageAnalystRating": "2.0 - Buy",
      "shortName": "TIM S.A.",
      "hasPrePostMarketData": true,
      "firstTradeDateMilliseconds": 911226600000,
      "preMarketChangePercent": 1.9021721,
      "regularMarketChangePercent": 8.71492,
      "displayName": "TIM",
      "symbol": "TIMB"
    }
  ],
  "useRecords": false,
  "predefinedScr": true,
  "versionId": 10,
  "creationDate": 1473796102800,
  "lastUpdated": 1699393457948,
  "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.