AVSearchEquitySymbol

Search for equity symbols given a string. ........ Example

new AVSearchEquitySymbol(search_string: string): any
Parameters
search_string (string) A string representing the equity symbol to search for.
Returns
any: A list of possible matches to the query

AVGetAvailableCryptoCurrencies

Gets the currently available crypto currencies.

new AVGetAvailableCryptoCurrencies(recalc_trigger: any): any
Parameters
recalc_trigger (any) (Optional) Argument to force recalc of function.
Returns
any: A list of available crypto currencies. Both code and description.

AVGetAvailablePhysicalCurrencies

Gets the currently available physical currencies.

new AVGetAvailablePhysicalCurrencies(recalc_trigger: any): any
Parameters
recalc_trigger (any) (Optional) Argument to force recalc of function.
Returns
any: A list of available physical currencies. Both code and description.

AVGetCompanyOverview

Gets an information overview for a company. ........ Example

new AVGetCompanyOverview(symbol: string, field_name: string, recalc_trigger: any): any
Parameters
symbol (string) Equity symbol.
field_name (string) (Optional) The name of the specific field. If 'all' or not specified will return full information.
recalc_trigger (any) (Optional) Argument to force recalc of function.
Returns
any: The overview for a company.

AVGetCurrencyExchangeRate

Gets the current exchange rate between 2 currencies. ........ Example

new AVGetCurrencyExchangeRate(from_currency: string, to_currency: string, field_name: string, recalc_trigger: any): any
Parameters
from_currency (string) Currency code converting from.
to_currency (string) Currency code converting to.
field_name (string) (Optional) The name of the specific quote field. If 'all' or not specified will return full quote.
recalc_trigger (any) (Optional) Argument to force recalc of function.
Returns
any: The exchange rate and associated info.

AVGetCurrentEquityQuote

Gets the current equity quote for a symbol. ........ Example

new AVGetCurrentEquityQuote(symbol: string, field_name: string, recalc_trigger: any): any
Parameters
symbol (string) Equity symbol.
field_name (string) (Optional) The name of the specific quote field. If 'all' or not specified will return full quote.
recalc_trigger (any) (Optional) Argument to force recalc of function.
Returns
any: The global equity quote and associated info.

AVGetCompanyEarnings

Gets the historical equity earnings. ........ Example

new AVGetCompanyEarnings(symbol: string, period: string, recalc_trigger: any): any
Parameters
symbol (string) Equity symbol.
period (string) Annual or Quarterly.
recalc_trigger (any) (Optional) Argument to force recalc of function.
Returns
any: The equity earnings history.

AVGetCurrencySeries

Gets the historical exchange rate between 2 currencies. ........ Example

new AVGetCurrencySeries(from_currency: string, to_currency: string, interval: string, opt_outputsize: string, recalc_trigger: any): any
Parameters
from_currency (string) Currency code converting from. Can be physical or crypto currency.
to_currency (string) Currency code converting to. Can only be physical currency.
interval (string) Frequency of returned time series (Monthly,Weekly,Daily,60min,30min,15min,5min,1min).
opt_outputsize (string) (Optional: 'compact' default) Full or compact series (full, compact).
recalc_trigger (any) (Optional) Argument to force recalc of function.
Returns
any: The exchange rate history.

AVGetEquitySeries

Gets the historical equity quotes for a series. ........ Example

new AVGetEquitySeries(symbol: string, interval: string, is_adjusted: string, opt_outputsize: string, recalc_trigger: any): any
Parameters
symbol (string) Equity symbol.
interval (string) Frequency of returned time series (Monthly,Weekly,Daily,60min,30min,15min,5min,1min).
is_adjusted (string) For raw equity quotes this is 'false'. Adjustments are for corporate actions.
opt_outputsize (string) (Optional: 'compact' default) Full or compact series (full, compact).
recalc_trigger (any) (Optional) Argument to force recalc of function.
Returns
any: The equity price history.

AVGetCompanyFilings

Gets the historical company filings. ........ Example

new AVGetCompanyFilings(symbol: string, filing: string, period: string, recalc_trigger: any): any
Parameters
symbol (string) Equity symbol.
filing (string) BalanceSheet, IncomeStatement or Cashflow.
period (string) Annual or Quarterly.
recalc_trigger (any) (Optional) Argument to force recalc of function.
Returns
any: The company filings history.

AVGetTechnicalIndicator

Gets the specified Technical Indicator history for a specific equity. ........ Example


See Full REST API Documentation.

new AVGetTechnicalIndicator(symbol: string, indicator: string, interval: string, argument_array: range, recalc_trigger: any): 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).
argument_array (range) 2 Column range with arguments specfic to this indicator.
recalc_trigger (any) (Optional) Argument to force recalc of function.
Returns
any: The indicator history.

AVGetListingStatus

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. ........ Example

new AVGetListingStatus(state: string, listing_date: (string | Date), recalc_trigger: any): any
Parameters
state (string) (Optional) active or delisted. Default is active.
listing_date ((string | Date)) (Optional) Specific date to check listing status for. Default is most recent date.
recalc_trigger (any) (Optional) Argument to force recalc of function.
Returns
any: The listing status of equities.

AVGetEarningsCalendar

Gets the earnings calendar for the specified horizon and optional symbol. ........ Example

new AVGetEarningsCalendar(horizon: string, symbol: string, recalc_trigger: any): 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.
recalc_trigger (any) (Optional) Argument to force recalc of function.
Returns
any: The earnings calendar.

AVGetIPOCalendar

Gets the IPO calendar for the next 3 months. ........ Example

new AVGetIPOCalendar(recalc_trigger: any): any
Parameters
recalc_trigger (any) (Optional) Argument to force recalc of function.
Returns
any: The IPO calendar for the next 3 months.