Skip to content

Latest commit

 

History

History
executable file
·
1111 lines (821 loc) · 53.1 KB

DATA.md

File metadata and controls

executable file
·
1111 lines (821 loc) · 53.1 KB
Raw

Classes

AlphaVantage

Further documentation can be found here: https://www.alphavantage.co/documentation/

IEX

Used to interact with the IEX api. See the official documentation for more: https://iextrading.com/developer/docs/#last

Nasdaq

For use with the Nasdaq's public data repository.

News

Represents an individual news article. Static functions retrieve News objects.

Query

Find and filter securities based on certain criteria.

Stream
Yahoo

Used to interact with the Yahoo Finance API.

AlphaVantage

Further documentation can be found here: https://www.alphavantage.co/documentation/

Kind: global class

new AlphaVantage(apiKey)

Creates a new AlphaVantage instance.

Param Type Description
apiKey String The free API key retrieved from

alphaVantage.sectorPerformance() ⇒ Promise

Returns an array of objects showing historical and real time S&P sector performance.

Kind: instance method of AlphaVantage
Author: Torrey Leonard https://github.com/Ladinn

alphaVantage.timeSeriesIntraday(symbol, interval) ⇒ Promise.<Array>

Returns an array of quotes for the equity specified, updated in real time.

Kind: instance method of AlphaVantage
Author: Torrey Leonard https://github.com/Ladinn

Param Type Description
symbol String
interval String How long each quote should represent: 1min, 5min, 15min, 30min, 60min

alphaVantage.timeSeriesDaily(symbol, compact, adjusted) ⇒ Promise.<Array>

Returns an array of quotes for the equity specified, covering up to 20 years of historical data.

Kind: instance method of AlphaVantage
Author: Torrey Leonard https://github.com/Ladinn

Param Type Description
symbol String
compact Boolean If true, this will return the last 100 data points. If false, it will return up to 20 years of historical data.
adjusted Boolean If true, prices will be adjusted for split/dividend events.

alphaVantage.timeSeriesWeekly(symbol, adjusted) ⇒ Promise.<Array>

Returns an array of quotes for the equity specified, covering up to 20 years of historical data.

Kind: instance method of AlphaVantage
Author: Torrey Leonard https://github.com/Ladinn

Param Type Description
symbol String
adjusted Boolean If true, prices will be adjusted for split/dividend events.

alphaVantage.timeSeriesMonthly(symbol, adjusted) ⇒ Promise.<Array>

Returns an array of quotes for the equity specified, covering up to 20 years of historical data.

Kind: instance method of AlphaVantage
Author: Torrey Leonard https://github.com/Ladinn

Param Type Description
symbol String
adjusted Boolean If true, prices will be adjusted for split/dividend events.

alphaVantage.search(keyword) ⇒ Promise.<Array>

Returns an array of matches for the search keyword.

Kind: instance method of AlphaVantage
Author: Nicklas Laine Overgaard https://github.com/nover

Param Type Description
keyword String The search keyword(s), e.g Microsoft or Apple

alphaVantage.sma(symbol, interval, timePeriod, seriesType, seriesType, seriesType) ⇒ Promise.<Array>

Returns an array of simple moving averages for the equity specified. https://www.investopedia.com/articles/technical/052201.asp

Kind: instance method of AlphaVantage
Author: Torrey Leonard https://github.com/Ladinn

Param Type Description
symbol String
interval String Time between two data points in the series: 1min, 5min, 15min, 30min, 60min, daily, weekly, monthly
timePeriod Number Number of data points used to calculate each moving average value. Positive integers are accepted.
seriesType String What to base the SMA on: open, high, low, close
seriesType String What to base the SMA on: open, high, low, close
seriesType String What to base the SMA on: open, high, low, close

alphaVantage.ema(symbol, interval, timePeriod, seriesType) ⇒ Promise.<Array>

Returns an array of exponential moving averages for the equity specified. https://www.investopedia.com/terms/e/ema.asp

Kind: instance method of AlphaVantage
Author: Torrey Leonard https://github.com/Ladinn

Param Type Description
symbol String
interval String Time between two data points in the series: 1min, 5min, 15min, 30min, 60min, daily, weekly, monthly
timePeriod Number Number of data points used to calculate each moving average value. Positive integers are accepted.
seriesType String What to base the SMA on: open, high, low, close

alphaVantage.wma(symbol, interval, timePeriod, seriesType) ⇒ Promise.<Array>

Returns an array of weighted moving averages for the equity specified. https://www.investopedia.com/articles/technical/060401.asp

Kind: instance method of AlphaVantage
Author: Torrey Leonard https://github.com/Ladinn

Param Type Description
symbol String
interval String Time between two data points in the series: 1min, 5min, 15min, 30min, 60min, daily, weekly, monthly
timePeriod Number Number of data points used to calculate each moving average value. Positive integers are accepted.
seriesType String What to base the SMA on: open, high, low, close

alphaVantage.dema(symbol, interval, timePeriod, seriesType) ⇒ Promise.<Array>

Returns an array of double exponential moving averages for the equity specified. http://www.investopedia.com/articles/trading/10/double-exponential-moving-average.asp

Kind: instance method of AlphaVantage
Author: Torrey Leonard https://github.com/Ladinn

Param Type Description
symbol String
interval String Time between two data points in the series: 1min, 5min, 15min, 30min, 60min, daily, weekly, monthly
timePeriod Number Number of data points used to calculate each moving average value. Positive integers are accepted.
seriesType String What to base the SMA on: open, high, low, close

alphaVantage.dema(symbol, interval, timePeriod, seriesType) ⇒ Promise.<Array>

Returns an array of double exponential moving averages for the equity specified. http://www.investopedia.com/articles/trading/10/double-exponential-moving-average.asp

Kind: instance method of AlphaVantage
Author: Torrey Leonard https://github.com/Ladinn

Param Type Description
symbol String
interval String Time between two data points in the series: 1min, 5min, 15min, 30min, 60min, daily, weekly, monthly
timePeriod Number Number of data points used to calculate each moving average value. Positive integers are accepted.
seriesType String What to base the SMA on: open, high, low, close

alphaVantage.tema(symbol, interval, timePeriod, seriesType) ⇒ Promise.<Array>

Returns an array of triple exponential moving averages for the equity specified. https://www.investopedia.com/terms/t/triple-exponential-moving-average.asp

Kind: instance method of AlphaVantage
Author: Torrey Leonard https://github.com/Ladinn

Param Type Description
symbol String
interval String Time between two data points in the series: 1min, 5min, 15min, 30min, 60min, daily, weekly, monthly
timePeriod Number Number of data points used to calculate each moving average value. Positive integers are accepted.
seriesType String What to base the SMA on: open, high, low, close

alphaVantage.trima(symbol, interval, timePeriod, seriesType) ⇒ Promise.<Array>

Returns an array of triangular moving averages for the equity specified. http://www.fmlabs.com/reference/default.htm?url=TriangularMA.htm

Kind: instance method of AlphaVantage
Author: Torrey Leonard https://github.com/Ladinn

Param Type Description
symbol String
interval String Time between two data points in the series: 1min, 5min, 15min, 30min, 60min, daily, weekly, monthly
timePeriod Number Number of data points used to calculate each moving average value. Positive integers are accepted.
seriesType String What to base the SMA on: open, high, low, close

alphaVantage.kama(symbol, interval, timePeriod, seriesType) ⇒ Promise.<Array>

Returns an array of Kaufman adaptive moving averages for the equity specified. http://stockcharts.com/school/doku.php?id=chart_school:technical_indicators:kaufman_s_adaptive_moving_average

Kind: instance method of AlphaVantage
Author: Torrey Leonard https://github.com/Ladinn

Param Type Description
symbol String
interval String Time between two data points in the series: 1min, 5min, 15min, 30min, 60min, daily, weekly, monthly
timePeriod Number Number of data points used to calculate each moving average value. Positive integers are accepted.
seriesType String What to base the SMA on: open, high, low, close

alphaVantage.mama(symbol, interval, timePeriod, seriesType, fastLimit, slowLimit) ⇒ Promise.<Array>

Returns an array of MESA adaptive moving averages for the equity specified. http://www.binarytribune.com/forex-trading-indicators/ehlers-mesa-adaptive-moving-average

Kind: instance method of AlphaVantage
Author: Torrey Leonard https://github.com/Ladinn

Param Type Description
symbol String
interval String Time between two data points in the series: 1min, 5min, 15min, 30min, 60min, daily, weekly, monthly
timePeriod Number Number of data points used to calculate each moving average value. Positive integers are accepted.
seriesType String What to base the SMA on: open, high, low, close
fastLimit Number
slowLimit Number

alphaVantage.t3(symbol, interval, timePeriod, seriesType) ⇒ Promise.<Array>

Returns an array of T3 values for the equity specified. http://www.fmlabs.com/reference/default.htm?url=T3.htm

Kind: instance method of AlphaVantage
Author: Torrey Leonard https://github.com/Ladinn

Param Type Description
symbol String
interval String Time between two data points in the series: 1min, 5min, 15min, 30min, 60min, daily, weekly, monthly
timePeriod Number Number of data points used to calculate each moving average value. Positive integers are accepted.
seriesType String What to base the SMA on: open, high, low, close

alphaVantage.macd(symbol, interval, timePeriod, seriesType, fastPeriod, slowPeriod, signalPeriod) ⇒ Promise.<Array>

Returns an array of moving average convergence / divergence values for the equity specified. http://www.investopedia.com/articles/forex/05/macddiverge.asp

Kind: instance method of AlphaVantage
Author: Torrey Leonard https://github.com/Ladinn

Param Type Description
symbol String
interval String Time between two data points in the series: 1min, 5min, 15min, 30min, 60min, daily, weekly, monthly
timePeriod Number Number of data points used to calculate each moving average value. Positive integers are accepted.
seriesType String What to base the SMA on: open, high, low, close
fastPeriod Number | Null
slowPeriod Number | Null
signalPeriod Number | Null

alphaVantage.macd(symbol, interval, timePeriod, seriesType, fastPeriod, slowPeriod, signalPeriod, fastMaType, slowMaType, signalMaType) ⇒ Promise.<Array>

Returns an array of moving average convergence / divergence values with controllable moving average type for the equity specified. http://www.investopedia.com/articles/forex/05/macddiverge.asp

Kind: instance method of AlphaVantage
Author: Torrey Leonard https://github.com/Ladinn

Param Type Description
symbol String
interval String Time between two data points in the series: 1min, 5min, 15min, 30min, 60min, daily, weekly, monthly
timePeriod Number Number of data points used to calculate each moving average value. Positive integers are accepted.
seriesType String What to base the SMA on: open, high, low, close
fastPeriod Number | Null
slowPeriod Number | Null
signalPeriod Number | Null
fastMaType Number | Null Integers 0 - 8 are accepted with the following mappings: 0 = Simple Moving Average (SMA), 1 = Exponential Moving Average (EMA), 2 = Weighted Moving Average (WMA), 3 = Double Exponential Moving Average (DEMA), 4 = Triple Exponential Moving Average (TEMA), 5 = Triangular Moving Average (TRIMA), 6 = T3 Moving Average, 7 = Kaufman Adaptive Moving Average (KAMA), 8 = MESA Adaptive Moving Average (MAMA).
slowMaType Number | Null Integers 0 - 8 are accepted with the following mappings: 0 = Simple Moving Average (SMA), 1 = Exponential Moving Average (EMA), 2 = Weighted Moving Average (WMA), 3 = Double Exponential Moving Average (DEMA), 4 = Triple Exponential Moving Average (TEMA), 5 = Triangular Moving Average (TRIMA), 6 = T3 Moving Average, 7 = Kaufman Adaptive Moving Average (KAMA), 8 = MESA Adaptive Moving Average (MAMA).
signalMaType Number | Null Integers 0 - 8 are accepted with the following mappings: 0 = Simple Moving Average (SMA), 1 = Exponential Moving Average (EMA), 2 = Weighted Moving Average (WMA), 3 = Double Exponential Moving Average (DEMA), 4 = Triple Exponential Moving Average (TEMA), 5 = Triangular Moving Average (TRIMA), 6 = T3 Moving Average, 7 = Kaufman Adaptive Moving Average (KAMA), 8 = MESA Adaptive Moving Average (MAMA).

alphaVantage.stoch(symbol, interval, timePeriod, seriesType, fastKPeriod, slowKPeriod, slowDPeriod, slowKmaType, slowDmaType) ⇒ Promise.<Array>

Returns an array of stochastic oscillators for the equity specified. http://www.investopedia.com/university/indicator_oscillator/ind_osc8.asp

Kind: instance method of AlphaVantage
Author: Torrey Leonard https://github.com/Ladinn

Param Type Description
symbol String
interval String Time between two data points in the series: 1min, 5min, 15min, 30min, 60min, daily, weekly, monthly
timePeriod Number Number of data points used to calculate each moving average value. Positive integers are accepted.
seriesType String What to base the SMA on: open, high, low, close
fastKPeriod Number | Null
slowKPeriod Number | Null
slowDPeriod Number | Null
slowKmaType Number | Null Integers 0 - 8 are accepted with the following mappings: 0 = Simple Moving Average (SMA), 1 = Exponential Moving Average (EMA), 2 = Weighted Moving Average (WMA), 3 = Double Exponential Moving Average (DEMA), 4 = Triple Exponential Moving Average (TEMA), 5 = Triangular Moving Average (TRIMA), 6 = T3 Moving Average, 7 = Kaufman Adaptive Moving Average (KAMA), 8 = MESA Adaptive Moving Average (MAMA).
slowDmaType Number | Null Integers 0 - 8 are accepted with the following mappings: 0 = Simple Moving Average (SMA), 1 = Exponential Moving Average (EMA), 2 = Weighted Moving Average (WMA), 3 = Double Exponential Moving Average (DEMA), 4 = Triple Exponential Moving Average (TEMA), 5 = Triangular Moving Average (TRIMA), 6 = T3 Moving Average, 7 = Kaufman Adaptive Moving Average (KAMA), 8 = MESA Adaptive Moving Average (MAMA).

alphaVantage.stochf(symbol, interval, timePeriod, seriesType, fastKPeriod, fastDPeriod, fastDmaType) ⇒ Promise.<Array>

Returns an array of stochastic fast oscillators for the equity specified. http://www.investopedia.com/university/indicator_oscillator/ind_osc8.asp

Kind: instance method of AlphaVantage
Author: Torrey Leonard https://github.com/Ladinn

Param Type Description
symbol String
interval String Time between two data points in the series: 1min, 5min, 15min, 30min, 60min, daily, weekly, monthly
timePeriod Number Number of data points used to calculate each moving average value. Positive integers are accepted.
seriesType String What to base the SMA on: open, high, low, close
fastKPeriod Number | Null
fastDPeriod Number | Null
fastDmaType Number | Null Integers 0 - 8 are accepted with the following mappings: 0 = Simple Moving Average (SMA), 1 = Exponential Moving Average (EMA), 2 = Weighted Moving Average (WMA), 3 = Double Exponential Moving Average (DEMA), 4 = Triple Exponential Moving Average (TEMA), 5 = Triangular Moving Average (TRIMA), 6 = T3 Moving Average, 7 = Kaufman Adaptive Moving Average (KAMA), 8 = MESA Adaptive Moving Average (MAMA).

alphaVantage.rsi(symbol, interval, timePeriod, seriesType) ⇒ Promise.<Array>

Returns an array of relative strength index values for the equity specified. http://www.investopedia.com/articles/technical/071601.asp

Kind: instance method of AlphaVantage
Author: Torrey Leonard https://github.com/Ladinn

Param Type Description
symbol String
interval String Time between two data points in the series: 1min, 5min, 15min, 30min, 60min, daily, weekly, monthly
timePeriod Number Number of data points used to calculate each moving average value. Positive integers are accepted.
seriesType String What to base the SMA on: open, high, low, close

alphaVantage.stochRSI(symbol, interval, timePeriod, seriesType, fastKPeriod, fastDPeriod, fastDmaType) ⇒ Promise.<Array>

Returns an array of stochastic relative strength index values for the equity specified. http://www.fmlabs.com/reference/default.htm?url=StochRSI.htm

Kind: instance method of AlphaVantage
Author: Torrey Leonard https://github.com/Ladinn

Param Type Description
symbol String
interval String Time between two data points in the series: 1min, 5min, 15min, 30min, 60min, daily, weekly, monthly
timePeriod Number Number of data points used to calculate each moving average value. Positive integers are accepted.
seriesType String What to base the SMA on: open, high, low, close
fastKPeriod Number | Null
fastDPeriod Number | Null
fastDmaType Number | Null Integers 0 - 8 are accepted with the following mappings: 0 = Simple Moving Average (SMA), 1 = Exponential Moving Average (EMA), 2 = Weighted Moving Average (WMA), 3 = Double Exponential Moving Average (DEMA), 4 = Triple Exponential Moving Average (TEMA), 5 = Triangular Moving Average (TRIMA), 6 = T3 Moving Average, 7 = Kaufman Adaptive Moving Average (KAMA), 8 = MESA Adaptive Moving Average (MAMA).

alphaVantage.bbands(symbol, interval, timePeriod, seriesType, nbdevup, nbdevdn, matype) ⇒ Promise.<Array>

Returns an array of bollinger bands for the equity specified. https://www.investopedia.com/articles/technical/04/030304.asp

Kind: instance method of AlphaVantage
Author: Torrey Leonard https://github.com/Ladinn

Param Type Description
symbol String
interval String Time interval between two consecutive data points in the time series. The following values are supported: 1min, 5min, 15min, 30min, 60min, daily, weekly, monthly
timePeriod Number Number of data points used to calculate each BBANDS value. Positive integers are accepted (e.g., time_period=60, time_period=200)
seriesType String The desired price type in the time series. Four types are supported: close, open, high, low
nbdevup Number | Null The standard deviation multiplier of the upper band. Positive integers are accepted. By default, nbdevup=2.
nbdevdn Number | Null The standard deviation multiplier of the lower band. Positive integers are accepted. By default, nbdevdn=2.
matype Number | Null Moving average type of the time series. By default, matype=0. Integers 0 - 8 are accepted with the following mappings. 0 = Simple Moving Average (SMA), 1 = Exponential Moving Average (EMA), 2 = Weighted Moving Average (WMA), 3 = Double Exponential Moving Average (DEMA), 4 = Triple Exponential Moving Average (TEMA), 5 = Triangular Moving Average (TRIMA), 6 = T3 Moving Average, 7 = Kaufman Adaptive Moving Average (KAMA), 8 = MESA Adaptive Moving Average (MAMA).

alphaVantage.minus_di(symbol, interval, timePeriod) ⇒ Promise.<Array>

This API returns the minus directional indicator (MINUS_DI) values http://www.investopedia.com/articles/technical/02/050602.asp

Kind: instance method of AlphaVantage
Author: Colin Gillingham https://github.com/Gillinghammer

Param Type Description
symbol String
interval String Time between two data points in the series: 1min, 5min, 15min, 30min, 60min, daily, weekly, monthly
timePeriod Number Number of data points used to calculate each moving average value. Positive integers are accepted.

alphaVantage.plus_di(symbol, interval, timePeriod) ⇒ Promise.<Array>

This API returns the plus directional indicator (PLUS_DI) values http://www.investopedia.com/articles/technical/02/050602.asp

Kind: instance method of AlphaVantage
Author: Colin Gillingham https://github.com/Gillinghammer

Param Type Description
symbol String
interval String Time between two data points in the series: 1min, 5min, 15min, 30min, 60min, daily, weekly, monthly
timePeriod Number Number of data points used to calculate each moving average value. Positive integers are accepted.

alphaVantage.adx(symbol, interval, timePeriod) ⇒ Promise.<Array>

This API returns the average directional movement index (ADX) values http://www.investopedia.com/articles/trading/07/adx-trend-indicator.as

Kind: instance method of AlphaVantage
Author: Colin Gillingham https://github.com/Gillinghammer

Param Type Description
symbol String
interval String Time between two data points in the series: 1min, 5min, 15min, 30min, 60min, daily, weekly, monthly
timePeriod Number Number of data points used to calculate each ADX value. Positive integers are accepted

IEX

Used to interact with the IEX api. See the official documentation for more: https://iextrading.com/developer/docs/#last

Kind: global class

IEX.getMarket() ⇒ Promise.<Market>

Returns a market object.

Kind: static method of IEX
Author: Colin Gillingham https://github.com/Gillinghammer

IEX.getQuote(symbol) ⇒ Promise.<Quote>

Returns a quote object for the given symbol.

Kind: static method of IEX
Author: Torrey Leonard https://github.com/Ladinn

Param Type
symbol String

IEX.getBatchQuotes(symbolArray) ⇒ Promise.<Array.<Quote>>

Returns an array of quote objects for the given symbols.

Kind: static method of IEX
Author: Torrey Leonard https://github.com/Ladinn

Param Type Description
symbolArray Array.<String> An array of symbols to query

IEX.getCompanyDetails(symbol) ⇒ Promise.<Object>

Returns an object containing data on the given company. https://iextrading.com/developer/docs/#company

Kind: static method of IEX
Author: Torrey Leonard https://github.com/Ladinn

Param Type
symbol String

IEX.getDividends(symbol) ⇒ Promise.<Object>

Returns an object containing data on dividends issued by the given company. https://iextrading.com/developer/docs/#dividends

Kind: static method of IEX
Author: Torrey Leonard https://github.com/Ladinn

Param Type
symbol String

IEX.getEarnings(symbol) ⇒ Promise.<Object>

Returns an object containing data on the four most recent earnings reports by the given company. https://iextrading.com/developer/docs/#earnings

Kind: static method of IEX
Author: Torrey Leonard https://github.com/Ladinn

Param Type
symbol String

IEX.getFinancials(symbol) ⇒ Promise.<Object>

Returns an object containing data on the given company's income statement, balance sheet, and cash flow from the four most recent reported quarters. https://iextrading.com/developer/docs/#financials

Kind: static method of IEX
Author: Torrey Leonard https://github.com/Ladinn

Param Type
symbol String

IEX.getStats(symbol) ⇒ Promise.<Object>

Returns an object containing data on the given company's market cap, beta, 52-week high & low, change, short intereste, dividend rate, float, EBITDA, cash, and more. https://iextrading.com/developer/docs/#key-stats

Kind: static method of IEX
Author: Torrey Leonard https://github.com/Ladinn

Param Type
symbol String

IEX.getLogo(symbol) ⇒ Promise.<String>

Returns a string containing a URL endpoint with the given company's logo. https://iextrading.com/developer/docs/#logo

Kind: static method of IEX
Author: Torrey Leonard https://github.com/Ladinn

Param Type
symbol String

IEX.getNews(symbol) ⇒ Promise.<Array.<News>>

Returns an array of news objects for the given symbol. https://iextrading.com/developer/docs/#logo

Kind: static method of IEX
Author: Torrey Leonard https://github.com/Ladinn

Param Type
symbol String

IEX.getPeers(symbol) ⇒ Promise.<Array.<String>>

Returns an array of peer tickers as defined by IEX. https://iextrading.com/developer/docs/#peers

Kind: static method of IEX
Author: Torrey Leonard https://github.com/Ladinn

Param Type
symbol String

IEX.getSplits(symbol) ⇒ Promise.<Object>

Returns an object containing data on stock splits issued by the given company. https://iextrading.com/developer/docs/#dividends

Kind: static method of IEX
Author: Torrey Leonard https://github.com/Ladinn

Param Type
symbol String

IEX.getVolumeByVenue(symbol) ⇒ Promise.<Array.<String>>

This returns 15 minute delayed and 30 day average consolidated volume percentage of a stock, by market. This call will always return 13 values, and will be sorted in ascending order by current day trading volume percentage. https://iextrading.com/developer/docs/#volume-by-venue

Kind: static method of IEX
Author: Torrey Leonard https://github.com/Ladinn

Param Type
symbol String

IEX.getAllSymbols() ⇒ Promise.<Array.<Object>>

Returns an array of symbols IEX supports for trading. https://iextrading.com/developer/docs/#symbols

Kind: static method of IEX
Author: Torrey Leonard https://github.com/Ladinn

Nasdaq

For use with the Nasdaq's public data repository.

Kind: global class

Nasdaq.getListings() ⇒ Promise.<Array.<Object>>

Returns an array of objects with details on Nasdaq listed equities.

Kind: static method of Nasdaq
Author: Torrey Leonard https://github.com/Ladinn

Nasdaq.getTraded() ⇒ Promise.<Array.<Object>>

Returns an array of objects with details on Nasdaq traded equities.

Kind: static method of Nasdaq
Author: Torrey Leonard https://github.com/Ladinn

Nasdaq.getOtherListings() ⇒ Promise.<Array.<Object>>

Returns an array of objects with details on other equities.

Kind: static method of Nasdaq
Author: Torrey Leonard https://github.com/Ladinn

Nasdaq.getOTCListings() ⇒ Promise.<Array.<Object>>

Returns an array of objects with details on OTC traded equities.

Kind: static method of Nasdaq
Author: Torrey Leonard https://github.com/Ladinn

Nasdaq.getByName(string) ⇒ Promise.<Array.<Object>>

Returns an array of objects with details on equities whose name matchs the given filter.

Kind: static method of Nasdaq
Author: Torrey Leonard https://github.com/Ladinn

Param Type
string String

Nasdaq.getETFs() ⇒ Promise.<Array.<String>>

Returns an array of symbols that represent exchange traded funds.

Kind: static method of Nasdaq
Author: Torrey Leonard https://github.com/Ladinn

News

Represents an individual news article. Static functions retrieve News objects.

Kind: global class

new News(object)

Creates a new News instance.

Param
object

news.getArticle() ⇒ Promise.<String>

Using the URL provided for the news article, this will return the contents of that page.

Kind: instance method of News
Author: Torrey Leonard https://github.com/Ladinn

news.getTitle() ⇒ String

Kind: instance method of News
Author: Torrey Leonard https://github.com/Ladinn

news.getDescription() ⇒ String

Kind: instance method of News
Author: Torrey Leonard https://github.com/Ladinn

news.getDate() ⇒ Date

Kind: instance method of News
Author: Torrey Leonard https://github.com/Ladinn

news.getSource() ⇒ String

Kind: instance method of News
Author: Torrey Leonard https://github.com/Ladinn

news.getAuthor() ⇒ String

Kind: instance method of News
Author: Torrey Leonard https://github.com/Ladinn

news.getURL() ⇒ String

Kind: instance method of News
Author: Torrey Leonard https://github.com/Ladinn

News.getFromYahoo(symbol) ⇒ Promise.<Array>

Returns an array of News objects for the given symbol.

Kind: static method of News
Author: Torrey Leonard https://github.com/Ladinn

Param Type
symbol String

News.getAll(apiKey, object)

Search through millions of articles from over 30,000 large and small news sources and blogs. This includes breaking news as well as lesser articles. Returns an array of News objects for the given symbol from News API.

Kind: static method of News
Author: Torrey Leonard https://github.com/Ladinn

Param Type Description
apiKey String Your News API key, found for free here: https://newsapi.org/register
object Object Further documentation can be found here: https://newsapi.org/docs/endpoints/everything

Properties

Name Type Description
q String Keywords or phrases to search for.
sources String A comma-separated string of identifiers (maximum 20) for the news sources or blogs you want headlines from.
domains String A comma-separated string of domains (eg bbc.co.uk, techcrunch.com, engadget.com) to restrict the search to.
from Date A date and optional time for the oldest article allowed.
to Date A date and optional time for the newest article allowed.
language String Possible options: 'ar,' 'de,' 'en,' 'es,' 'fr,' 'he,' 'it,' 'nl,' 'no,' 'pt,' 'ru,' 'se,' 'ud,' 'zh'
sortBy String Possible options: 'relevancy,' 'popularity,' 'publishedAt'
pageSize Number The number of results to return per page. 20 is the default, 100 is the maximum.
page Number Use this to page through the results.

News.getHeadlines(apiKey, object)

This endpoint provides live top and breaking headlines for a country, specific category in a country, single source, or multiple sources. You can also search with keywords. Articles are sorted by the earliest date published first. Returns an array of News objects for the given symbol from News API.

Kind: static method of News
Author: Torrey Leonard https://github.com/Ladinn

Param Type Description
apiKey String Your News API key, found for free here: https://newsapi.org/register
object Object Further documentation can be found here: https://newsapi.org/docs/endpoints/top-headlines

Properties

Name Type Description
q String Keywords or phrases to search for.
category String Possible options: 'business,' 'entertainment,' 'general,' 'health,' 'science,' 'sports,' 'technology' (Cannot be mixed with sources parameter)
country String The 2-letter ISO 3166-1 code of the country you want to get headlines for. (Cannot be mixed with sources parameter)
sources String A comma-separated string of identifiers (maximum 20) for the news sources or blogs you want headlines from. (Cannot be mixed with country parameter)
pageSize Number The number of results to return per page. 20 is the default, 100 is the maximum.
page Number Use this to page through the results.

Query

Find and filter securities based on certain criteria.

Kind: global class

Query.search(string) ⇒ Promise.<Array>

Searches for a given symbol based on the given string.

Kind: static method of Query
Author: Torrey Leonard https://github.com/Ladinn

Param Type Description
string String Search query.

Query.getTopGainers(count) ⇒ Promise.<Array>

Returns an array of quotes for the best performing 'x' amount of stocks.

Kind: static method of Query
Author: Torrey Leonard https://github.com/Ladinn

Param Type
count Number

Query.getTopLosers(count) ⇒ Promise.<Array>

Returns an array of quotes for the worst performing 'x' amount of stocks.

Kind: static method of Query
Author: Torrey Leonard https://github.com/Ladinn

Param Type
count Number

Query.getHighestVolume(count) ⇒ Promise.<Array>

Returns an array of quotes for 'x' amount of stocks with the highest volume today.

Kind: static method of Query
Author: Torrey Leonard https://github.com/Ladinn

Param Type
count Number

Query.getHighestOpenInterest(count) ⇒ Promise.<Array>

Returns an array of quotes for options with the highest open interest.

Kind: static method of Query
Author: Torrey Leonard https://github.com/Ladinn

Param Type
count Number

Query.getTopETFs(count) ⇒ Promise.<Array>

Returns an array of quotes for the most actively traded ETFs.

Kind: static method of Query
Author: Torrey Leonard https://github.com/Ladinn

Param Type
count Number

Query.getSimilar(symbol) ⇒ Promise.<Array>

Returns an array of equities similar to the one given.

Kind: static method of Query
Author: Torrey Leonard https://github.com/Ladinn

Param Type
symbol String

Query.getTrendingSymbols(count) ⇒ Promise.<Array>

Returns an array of 'x' amount of trending symbols on Yahoo Finance.

Kind: static method of Query
Author: Torrey Leonard https://github.com/Ladinn

Param Type
count Number

Query.getEarnings(days) ⇒ Promise.<Array>

Returns an array of objects with information on companies that are reporting earnings within 'x' number of days, along with estimates and call URLs.

Kind: static method of Query
Author: Torrey Leonard https://github.com/Ladinn

Param Type
days Number

Query.getEarningsBySymbol(symbol) ⇒ Promise.<Object>

Returns an object containing this company's past and future earnings data.

Kind: static method of Query
Author: Torrey Leonard https://github.com/Ladinn

Param Type
symbol String

Stream

Kind: global class
Author: Torrey Leonard https://github.com/Ladinn
Properties

Name Type Description
iex Boolean Whether to include real time IEX data in stream
iexType String Which endpoint to use for IEX stream (tops, last, hist, deep, book, etc. See: https://iextrading.com/developer/docs/#iex-market-data)
news Boolean Whether to include news headlines in the stream.
allHeadlines Boolean If true, all U.S. business headlines will be sent in the stream. If false, only news pertaining to the given symbols will be outputted.
newsApiKey String If 'includeNews' is yes, this should be your API key from https://newsapi.org/register.

new Stream(symbols, options)

Creates a new Stream class.

Param Type
symbols Array
options Object | Null

stream.start()

Start the streaming class.

Kind: instance method of Stream
Author: Torrey Leonard https://github.com/Ladinn

stream.stop()

Stop the streaming class.

Kind: instance method of Stream
Author: Torrey Leonard https://github.com/Ladinn
Author: Wyatt Calandro https://github.com/wclandro

"iex"

An extension of the Node.js EventEmitter that sends Quote and News objects as they arrive.

Kind: event emitted by Stream

Yahoo

Used to interact with the Yahoo Finance API.

Kind: global class

Yahoo.getQuotes

Kind: static class of Yahoo
Author: Torrey Leonard https://github.com/Ladinn

new Yahoo.getQuotes(symbol, range, interval, extended)

Returns an array of Quote objects from Yahoo Finance.

Param Type Description
symbol String
range String How far back to retrieve data: [1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 5y, 10y, ytd, max]
interval String How long each quote should represent: [1m, 2m, 5m, 15m, 30m, 60m, 90m, 1h, 1d, 5d, 1wk, 1mo, 3mo]
extended Boolean Whether to include data from extended trading hours.

Yahoo.getOptionsChain(symbol) ⇒ Promise.<OptionsChain>

Returns a new OptionsChain object with data from Yahoo Finance.

Kind: static method of Yahoo
Author: Torrey Leonard https://github.com/Ladinn

Param Type
symbol String