EquityQuote

Gets the current equity quote for a symbol.

new EquityQuote(symbol: string, fieldName: string?): Promise<Array<Array<any>>>
Parameters
symbol (string) Equity symbol.
fieldName (string?) The name of the specific quote field. If 'all' or not specified will return full quote.
Returns
Promise<Array<Array<any>>>: A range with the Equity quote information
Related
REST API documentation

EquityTimeSeries

Gets the historical equity quotes for a series.

new EquityTimeSeries(symbol: string, interval: string, isAdjusted: boolean?, optOutputsize: string?, extendedHours: boolean?, month: string?): Promise<Array<Array<any>>>
Parameters
symbol (string) Equity symbol.
interval (string) Frequency of returned time series (Monthly,Weekly,Daily,60min,30min,15min,5min,1min).
isAdjusted (boolean?) (Optional: default is FALSE) Adjustments are for corporate actions. A value of FALSE gives the raw reported number.
optOutputsize (string?) (Optional: default value set by user) Full or compact series (full, compact).
extendedHours (boolean?) (Optional: default is TRUE) If extended hours is FALSE, values will be limited to being between 9:30AM-4:00PM in the time zone ‘America/New_York’. This setting only applies to intraday data.
month (string?) (Optional: if missing, recent data is returned) Return a full month of intraday data. Input format YYYY-MM. This setting only applies to intraday data.
Returns
Promise<Array<Array<any>>>: A range with the equity price history.
Related
REST api documentation

ExchangeRate

Gets the current exchange rate between 2 currencies.

new ExchangeRate(fromCurrency: string, toCurrency: string, fieldName: string?): Promise<Array<Array<any>>>
Parameters
fromCurrency (string) Currency code converting from.
toCurrency (string) Currency code converting to.
fieldName (string?) (Optional) The name of the specific quote field. If 'all' or not specified will return full quote.
Returns
Promise<Array<Array<any>>>: A range with the exchange rate and associated info.
Related
REST API documentation

ExchangeRateUpdating

Gets the updating exchange rate between 2 currencies.

new ExchangeRateUpdating(fromCurrency: string, toCurrency: string, fieldName: string, updateIntervalInSeconds: number, invocation: CustomFunctions.StreamingInvocation<Array<Array<any>>>): void
Parameters
fromCurrency (string) Currency code converting from.
toCurrency (string) Currency code converting to.
fieldName (string) The name of the specific quote field. If 'all' will return full quote.
updateIntervalInSeconds (number) Seconds between updates. Shortest valid interval is 30 seconds.
invocation (CustomFunctions.StreamingInvocation<Array<Array<any>>>)
Returns
void: A range with the exchange rate and associated info.
Related
REST API documentation

ExchangeRateSeries

Gets the historical exchange rate between 2 currencies.

new ExchangeRateSeries(fromCurrency: string, toCurrency: string, interval: string, optOutputsize: string?): Promise<Array<Array<any>>>
Parameters
fromCurrency (string) Currency code converting from. This field can be a physical or crypto currency
toCurrency (string) Currency code converting to. This field can only be a physical currency
interval (string) Frequency of returned time series (Monthly,Weekly,Daily,60min,30min,15min,5min,1min).
optOutputsize (string?) (Optional: default value set by user) Full or compact series (full, compact).
Returns
Promise<Array<Array<any>>>: A range with exchange rate history.
Related
REST API documentation

ExchangeRateSeriesUpdating

Gets the updating historical exchange rate between 2 currencies. Really only useful for intraday

new ExchangeRateSeriesUpdating(fromCurrency: string, toCurrency: string, interval: string, optOutputsize: string, invocation: StreamingInvocation?): void
Parameters
fromCurrency (string) Currency code converting from. This field can be a physical or crypto currency
toCurrency (string) Currency code converting to. This field can only be a physical currency
interval (string) Frequency of returned time series (Monthly,Weekly,Daily,60min,30min,15min,5min,1min).
optOutputsize (string) ('compact' default) Full or compact series (full, compact). Omit value to use default
invocation (StreamingInvocation?) (NOT VISIBLE TO USER) The callback that handles the response
Returns
void: A range with the updating equity price history. Updates at the same frequency as interval
Related
REST API documentation

TechnicalIndicator

Gets the specified Technical Indicator history for a specific equity.

new TechnicalIndicator(symbol: string, indicator: string, interval: string, argumentArray: Array<Array<any>>?): Promise<Array<Array<any>>>
Parameters
symbol (string) Equity symbol.
indicator (string) Name of the Indicator.
interval (string) Frequency of returned time series (Monthly,Weekly,Daily,60min,30min,15min,5min,1min).
argumentArray (Array<Array<any>>?) 2 Column range with arguments specfic to this indicator. See Full Documentation
Returns
Promise<Array<Array<any>>>: A range with the indicator history.
Related
REST API documentation

SymbolSearch

Search for equity symbols given a string

new SymbolSearch(searchString: string): Promise<Array<Array<any>>>
Parameters
searchString (string) A string representing the equity symbol to search for.
Returns
Promise<Array<Array<any>>>: A range with a list of possible matches to the query
Related
REST API documentation

CommodityTimeSeries

Gets the historical commodity quotes as a series.

new CommodityTimeSeries(commodityCode: string, interval: string): Promise<Array<Array<any>>>
Parameters
commodityCode (string) Corresponds to the function argument in the main REST API . Valid values "WTI", "BRENT", "NATURAL_GAS", "COPPER", "ALUMINUM", "WHEAT", "CORN", "COTTON", "SUGAR", "COFFEE", "ALL_COMMODITIES"
interval (string) Frequency of returned time series (Monthly,Weekly,Daily) or (Annual,Quarterly,Monthly) depending on the commodity.
Returns
Promise<Array<Array<any>>>: A range with the commodity price history.
Related
REST api documentation

AvailableCryptoCurrencies

Gets the currently available crypto currencies.

new AvailableCryptoCurrencies(): Promise<Array<Array<any>>>
Returns
Promise<Array<Array<any>>>: A range with a list of available crypto currencies (2 columns). Both code and description.

AvailablePhysicalCurrencies

Gets the currently available physical currencies.

new AvailablePhysicalCurrencies(): Promise<Array<Array<any>>>
Returns
Promise<Array<Array<any>>>: A range with a list of available physical currencies (2 columns). Both code and description.

CompanyOverview

Gets an information overview for a company.

new CompanyOverview(symbol: string, fieldName: string): Promise<Array<Array<any>>>
Parameters
symbol (string) Equity symbol.
fieldName (string) (Optional) The name of the specific field. If 'all' or not specified will return full information.
Returns
Promise<Array<Array<any>>>: The overview for a company.
Related
REST API documentation

CompanyEarnings

Gets the historical equity earnings.

new CompanyEarnings(symbol: string, period: string): Promise<Array<Array<any>>>
Parameters
symbol (string) Equity symbol.
period (string) Annual or Quarterly.
Returns
Promise<Array<Array<any>>>: The equity earnings history.
Related
REST API documentation

CompanyFilings

Gets the historical company filings.

new CompanyFilings(symbol: string, filing: string, period: string): Promise<Array<Array<any>>>
Parameters
symbol (string) Equity symbol.
filing (string) BalanceSheet, IncomeStatement or Cashflow.
period (string) Annual or Quarterly.
Returns
Promise<Array<Array<any>>>: The company filings history.
Related
REST API documentation

ListingStatus

Gets the listing status of equities on the latest date. If a date is entered it will return the listing status of the equities for that date. This function returns a lot of data so it may take 20 seconds or more depending on your hardware and internet connection.

new ListingStatus(state: string, listing_date: any): Promise<Array<Array<any>>>
Parameters
state (string) (Optional) active or delisted. Default is active.
listing_date (any) (Optional) Specific date to check listing status for. Default is most recent date.
Returns
Promise<Array<Array<any>>>: The listing status of equities.
Related
REST API documentation

EarningsCalendar

Gets the earnings calendar for the specified horizon and optional symbol. When not specifying a symbol this function returns a lot of data so it may take 20 seconds or more depending on your hardware and internet connection.

new EarningsCalendar(horizon: string, symbol: string): Promise<Array<Array<any>>>
Parameters
horizon (string) (Optional) 3month, 6month or 12month. Default is 3month
symbol (string) (Optional) Equity symbol. If specified the output is limited to the calendar for that equity.
Returns
Promise<Array<Array<any>>>: The earnings calendar.
Related
REST API documentation

EconomicIndicator

Gets historical values for the requested Economic Indicator. Allowed indicators (CONSUMER_SENTIMENT, DURABLES, INFLATION, INFLATION_EXPECTATION, NONFARM_PAYROLL, REAL_GDP_PER_CAPITA, RETAIL_SALES, UNEMPLOYMENT, CPI, FEDERAL_FUNDS_RATE, REAL_GDP)

new EconomicIndicator(indicator: string, interval: string): Promise<Array<Array<any>>>
Parameters
indicator (string) Economic Indicator to retrieve. Allowed values(CONSUMER_SENTIMENT, DURABLES, INFLATION, INFLATION_EXPECTATION, NONFARM_PAYROLL, REAL_GDP_PER_CAPITA, RETAIL_SALES, UNEMPLOYMENT, CPI, FEDERAL_FUNDS_RATE, REAL_GDP)
interval (string) (Optional) The time interval of the series. Depends on the specific indicator. Ignored if the specific indicator doesn't take this option.
Returns
Promise<Array<Array<any>>>: The economic indicator history.
Related
REST API documentation

TreasuryYield

Gets the historical US Treasury yields for the specified constant maturity. Allowed maturities (3month, 2year, 5year, 7year, 10year, 30year). Allowed intervals (daily, weekly, monthly)

new TreasuryYield(maturity: string, interval: string): Promise<Array<Array<any>>>
Parameters
maturity (string) Tenor or Constant Maturity of the treasury yield. Allowed values(3month, 2year, 5year, 7year, 10year, 30year). If not specified defaults to 10year
interval (string) (Optional) The time interval of the series. Allowed intervals (daily, weekly, monthly)
Returns
Promise<Array<Array<any>>>: The treasury yield history.
Related
REST API documentation