finnhub-ts/api.ts

OpenAPI client for finnhub-ts

/* tslint:disable */
/* eslint-disable */
/**
 * Finnhub API
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: 1.0.0
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

import { Configuration } from './configuration'
import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base'

/**
 *
 * @export
 * @interface AggregateIndicators
 */
export interface AggregateIndicators {
  /**
   *
   * @type {TechnicalAnalysis}
   * @memberof AggregateIndicators
   */
  technicalAnalysis?: TechnicalAnalysis
  /**
   *
   * @type {Trend}
   * @memberof AggregateIndicators
   */
  trend?: Trend
}
/**
 *
 * @export
 * @interface BasicFinancials
 */
export interface BasicFinancials {
  /**
   * Symbol of the company.
   * @type {string}
   * @memberof BasicFinancials
   */
  symbol?: string
  /**
   * Metric type.
   * @type {string}
   * @memberof BasicFinancials
   */
  metricType?: string
  /**
   *
   * @type {object}
   * @memberof BasicFinancials
   */
  series?: object
  /**
   *
   * @type {object}
   * @memberof BasicFinancials
   */
  metric?: object
}
/**
 *
 * @export
 * @interface BondCandles
 */
export interface BondCandles {
  /**
   * List of close prices for returned candles.
   * @type {Array<number>}
   * @memberof BondCandles
   */
  c?: Array<number>
  /**
   * List of timestamp for returned candles.
   * @type {Array<number>}
   * @memberof BondCandles
   */
  t?: Array<number>
  /**
   * Status of the response. This field can either be ok or no_data.
   * @type {string}
   * @memberof BondCandles
   */
  s?: string
}
/**
 *
 * @export
 * @interface BondProfile
 */
export interface BondProfile {
  /**
   * ISIN.
   * @type {string}
   * @memberof BondProfile
   */
  isin?: string
  /**
   * Cusip.
   * @type {string}
   * @memberof BondProfile
   */
  cusip?: string
  /**
   * FIGI.
   * @type {string}
   * @memberof BondProfile
   */
  figi?: string
  /**
   * Coupon.
   * @type {number}
   * @memberof BondProfile
   */
  coupon?: number
  /**
   * Period.
   * @type {string}
   * @memberof BondProfile
   */
  maturityDate?: string
  /**
   * Offering price.
   * @type {number}
   * @memberof BondProfile
   */
  offeringPrice?: number
  /**
   * Issue date.
   * @type {string}
   * @memberof BondProfile
   */
  issueDate?: string
  /**
   * Bond type.
   * @type {string}
   * @memberof BondProfile
   */
  bondType?: string
  /**
   * Bond type.
   * @type {string}
   * @memberof BondProfile
   */
  debtType?: string
  /**
   * Industry.
   * @type {string}
   * @memberof BondProfile
   */
  industryGroup?: string
  /**
   * Sub-Industry.
   * @type {string}
   * @memberof BondProfile
   */
  industrySubGroup?: string
  /**
   * Asset.
   * @type {string}
   * @memberof BondProfile
   */
  asset?: string
  /**
   * Asset.
   * @type {string}
   * @memberof BondProfile
   */
  assetType?: string
  /**
   * Dated date.
   * @type {string}
   * @memberof BondProfile
   */
  datedDate?: string
  /**
   * First coupon date.
   * @type {string}
   * @memberof BondProfile
   */
  firstCouponDate?: string
  /**
   * Offering amount.
   * @type {number}
   * @memberof BondProfile
   */
  originalOffering?: number
  /**
   * Outstanding amount.
   * @type {number}
   * @memberof BondProfile
   */
  amountOutstanding?: number
  /**
   * Payment frequency.
   * @type {string}
   * @memberof BondProfile
   */
  paymentFrequency?: string
  /**
   * Security level.
   * @type {string}
   * @memberof BondProfile
   */
  securityLevel?: string
  /**
   * Callable.
   * @type {boolean}
   * @memberof BondProfile
   */
  callable?: boolean
  /**
   * Coupon type.
   * @type {string}
   * @memberof BondProfile
   */
  couponType?: string
}
/**
 *
 * @export
 * @interface BreakdownItem
 */
export interface BreakdownItem {
  /**
   * Access number of the report from which the data is sourced.
   * @type {string}
   * @memberof BreakdownItem
   */
  accessNumber?: string
  /**
   *
   * @type {object}
   * @memberof BreakdownItem
   */
  breakdown?: object
}
/**
 *
 * @export
 * @interface Company
 */
export interface Company {
  /**
   * Executive name
   * @type {string}
   * @memberof Company
   */
  name?: string
  /**
   * Age
   * @type {number}
   * @memberof Company
   */
  age?: number
  /**
   * Title
   * @type {string}
   * @memberof Company
   */
  title?: string
  /**
   * Year first appointed as executive/director of the company
   * @type {string}
   * @memberof Company
   */
  since?: string
  /**
   * Sex
   * @type {string}
   * @memberof Company
   */
  sex?: string
  /**
   * Total compensation
   * @type {number}
   * @memberof Company
   */
  compensation?: number
  /**
   * Compensation currency
   * @type {string}
   * @memberof Company
   */
  currency?: string
}
/**
 *
 * @export
 * @interface CompanyESG
 */
export interface CompanyESG {
  /**
   * symbol
   * @type {string}
   * @memberof CompanyESG
   */
  symbol?: string
  /**
   * Total ESG Score
   * @type {number}
   * @memberof CompanyESG
   */
  totalESGScore?: number
  /**
   * Environment Score
   * @type {number}
   * @memberof CompanyESG
   */
  environmentScore?: number
  /**
   * Governance Score
   * @type {number}
   * @memberof CompanyESG
   */
  governanceScore?: number
  /**
   * Social Score
   * @type {number}
   * @memberof CompanyESG
   */
  socialScore?: number
  /**
   *
   * @type {object}
   * @memberof CompanyESG
   */
  data?: object
}
/**
 *
 * @export
 * @interface CompanyEarningsQualityScore
 */
export interface CompanyEarningsQualityScore {
  /**
   * Symbol
   * @type {string}
   * @memberof CompanyEarningsQualityScore
   */
  symbol?: string
  /**
   * Frequency
   * @type {string}
   * @memberof CompanyEarningsQualityScore
   */
  freq?: string
  /**
   * Array of earnings quality score.
   * @type {Array<CompanyEarningsQualityScoreData>}
   * @memberof CompanyEarningsQualityScore
   */
  data?: Array<CompanyEarningsQualityScoreData>
}
/**
 *
 * @export
 * @interface CompanyEarningsQualityScoreData
 */
export interface CompanyEarningsQualityScoreData {
  /**
   * Period
   * @type {string}
   * @memberof CompanyEarningsQualityScoreData
   */
  period?: string
  /**
   * Growth Score
   * @type {number}
   * @memberof CompanyEarningsQualityScoreData
   */
  growth?: number
  /**
   * Profitability Score
   * @type {number}
   * @memberof CompanyEarningsQualityScoreData
   */
  profitability?: number
  /**
   * Cash Generation and Capital Allocation
   * @type {number}
   * @memberof CompanyEarningsQualityScoreData
   */
  cashGenerationCapitalAllocation?: number
  /**
   * Leverage Score
   * @type {number}
   * @memberof CompanyEarningsQualityScoreData
   */
  leverage?: number
  /**
   * Total Score
   * @type {number}
   * @memberof CompanyEarningsQualityScoreData
   */
  score?: number
  /**
   * Letter Score
   * @type {string}
   * @memberof CompanyEarningsQualityScoreData
   */
  letterScore?: string
}
/**
 *
 * @export
 * @interface CompanyExecutive
 */
export interface CompanyExecutive {
  /**
   * Company symbol.
   * @type {string}
   * @memberof CompanyExecutive
   */
  symbol?: string
  /**
   * Array of company\'s executives and members of the Board.
   * @type {Array<Company>}
   * @memberof CompanyExecutive
   */
  executive?: Array<Company>
}
/**
 *
 * @export
 * @interface CompanyNews
 */
export interface CompanyNews {
  /**
   * News category.
   * @type {string}
   * @memberof CompanyNews
   */
  category?: string
  /**
   * Published time in UNIX timestamp.
   * @type {number}
   * @memberof CompanyNews
   */
  datetime?: number
  /**
   * News headline.
   * @type {string}
   * @memberof CompanyNews
   */
  headline?: string
  /**
   * News ID. This value can be used for <code>minId</code> params to get the latest news only.
   * @type {number}
   * @memberof CompanyNews
   */
  id?: number
  /**
   * Thumbnail image URL.
   * @type {string}
   * @memberof CompanyNews
   */
  image?: string
  /**
   * Related stocks and companies mentioned in the article.
   * @type {string}
   * @memberof CompanyNews
   */
  related?: string
  /**
   * News source.
   * @type {string}
   * @memberof CompanyNews
   */
  source?: string
  /**
   * News summary.
   * @type {string}
   * @memberof CompanyNews
   */
  summary?: string
  /**
   * URL of the original article.
   * @type {string}
   * @memberof CompanyNews
   */
  url?: string
}
/**
 *
 * @export
 * @interface CompanyNewsStatistics
 */
export interface CompanyNewsStatistics {
  /**
   *
   * @type {number}
   * @memberof CompanyNewsStatistics
   */
  articlesInLastWeek?: number
  /**
   *
   * @type {number}
   * @memberof CompanyNewsStatistics
   */
  buzz?: number
  /**
   *
   * @type {number}
   * @memberof CompanyNewsStatistics
   */
  weeklyAverage?: number
}
/**
 *
 * @export
 * @interface CompanyProfile
 */
export interface CompanyProfile {
  /**
   * Address of company\'s headquarter.
   * @type {string}
   * @memberof CompanyProfile
   */
  address?: string
  /**
   * City of company\'s headquarter.
   * @type {string}
   * @memberof CompanyProfile
   */
  city?: string
  /**
   * Country of company\'s headquarter.
   * @type {string}
   * @memberof CompanyProfile
   */
  country?: string
  /**
   * Currency used in company filings.
   * @type {string}
   * @memberof CompanyProfile
   */
  currency?: string
  /**
   * CUSIP number.
   * @type {string}
   * @memberof CompanyProfile
   */
  cusip?: string
  /**
   * Sedol number.
   * @type {string}
   * @memberof CompanyProfile
   */
  sedol?: string
  /**
   * Company business summary.
   * @type {string}
   * @memberof CompanyProfile
   */
  description?: string
  /**
   * Listed exchange.
   * @type {string}
   * @memberof CompanyProfile
   */
  exchange?: string
  /**
   * Industry group.
   * @type {string}
   * @memberof CompanyProfile
   */
  ggroup?: string
  /**
   * Industry.
   * @type {string}
   * @memberof CompanyProfile
   */
  gind?: string
  /**
   * Sector.
   * @type {string}
   * @memberof CompanyProfile
   */
  gsector?: string
  /**
   * Sub-industry.
   * @type {string}
   * @memberof CompanyProfile
   */
  gsubind?: string
  /**
   * ISIN number.
   * @type {string}
   * @memberof CompanyProfile
   */
  isin?: string
  /**
   * NAICS national industry.
   * @type {string}
   * @memberof CompanyProfile
   */
  naicsNationalIndustry?: string
  /**
   * NAICS industry.
   * @type {string}
   * @memberof CompanyProfile
   */
  naics?: string
  /**
   * NAICS sector.
   * @type {string}
   * @memberof CompanyProfile
   */
  naicsSector?: string
  /**
   * NAICS subsector.
   * @type {string}
   * @memberof CompanyProfile
   */
  naicsSubsector?: string
  /**
   * Company name.
   * @type {string}
   * @memberof CompanyProfile
   */
  name?: string
  /**
   * Company phone number.
   * @type {string}
   * @memberof CompanyProfile
   */
  phone?: string
  /**
   * State of company\'s headquarter.
   * @type {string}
   * @memberof CompanyProfile
   */
  state?: string
  /**
   * Company symbol/ticker as used on the listed exchange.
   * @type {string}
   * @memberof CompanyProfile
   */
  ticker?: string
  /**
   * Company website.
   * @type {string}
   * @memberof CompanyProfile
   */
  weburl?: string
  /**
   * IPO date.
   * @type {string}
   * @memberof CompanyProfile
   */
  ipo?: string
  /**
   * Market Capitalization.
   * @type {number}
   * @memberof CompanyProfile
   */
  marketCapitalization?: number
  /**
   * Number of oustanding shares.
   * @type {number}
   * @memberof CompanyProfile
   */
  shareOutstanding?: number
  /**
   * Number of employee.
   * @type {number}
   * @memberof CompanyProfile
   */
  employeeTotal?: number
  /**
   * Logo image.
   * @type {string}
   * @memberof CompanyProfile
   */
  logo?: string
  /**
   * Finnhub industry classification.
   * @type {string}
   * @memberof CompanyProfile
   */
  finnhubIndustry?: string
}
/**
 *
 * @export
 * @interface CompanyProfile2
 */
export interface CompanyProfile2 {
  /**
   * Country of company\'s headquarter.
   * @type {string}
   * @memberof CompanyProfile2
   */
  country?: string
  /**
   * Currency used in company filings.
   * @type {string}
   * @memberof CompanyProfile2
   */
  currency?: string
  /**
   * Listed exchange.
   * @type {string}
   * @memberof CompanyProfile2
   */
  exchange?: string
  /**
   * Company name.
   * @type {string}
   * @memberof CompanyProfile2
   */
  name?: string
  /**
   * Company symbol/ticker as used on the listed exchange.
   * @type {string}
   * @memberof CompanyProfile2
   */
  ticker?: string
  /**
   * IPO date.
   * @type {string}
   * @memberof CompanyProfile2
   */
  ipo?: string
  /**
   * Market Capitalization.
   * @type {number}
   * @memberof CompanyProfile2
   */
  marketCapitalization?: number
  /**
   * Number of oustanding shares.
   * @type {number}
   * @memberof CompanyProfile2
   */
  shareOutstanding?: number
  /**
   * Logo image.
   * @type {string}
   * @memberof CompanyProfile2
   */
  logo?: string
  /**
   * Company phone number.
   * @type {string}
   * @memberof CompanyProfile2
   */
  phone?: string
  /**
   * Company website.
   * @type {string}
   * @memberof CompanyProfile2
   */
  weburl?: string
  /**
   * Finnhub industry classification.
   * @type {string}
   * @memberof CompanyProfile2
   */
  finnhubIndustry?: string
}
/**
 *
 * @export
 * @interface CountryMetadata
 */
export interface CountryMetadata {
  /**
   * Country name
   * @type {string}
   * @memberof CountryMetadata
   */
  country?: string
  /**
   * Alpha 2 code
   * @type {string}
   * @memberof CountryMetadata
   */
  code2?: string
  /**
   * Alpha 3 code
   * @type {string}
   * @memberof CountryMetadata
   */
  code3?: string
  /**
   * UN code
   * @type {string}
   * @memberof CountryMetadata
   */
  codeNo?: string
  /**
   * Currency name
   * @type {string}
   * @memberof CountryMetadata
   */
  currency?: string
  /**
   * Currency code
   * @type {string}
   * @memberof CountryMetadata
   */
  currencyCode?: string
  /**
   * Region
   * @type {string}
   * @memberof CountryMetadata
   */
  region?: string
  /**
   * Sub-Region
   * @type {string}
   * @memberof CountryMetadata
   */
  subRegion?: string
}
/**
 *
 * @export
 * @interface CovidInfo
 */
export interface CovidInfo {
  /**
   * State.
   * @type {string}
   * @memberof CovidInfo
   */
  state?: string
  /**
   * Number of confirmed cases.
   * @type {number}
   * @memberof CovidInfo
   */
  case?: number
  /**
   * Number of confirmed deaths.
   * @type {number}
   * @memberof CovidInfo
   */
  death?: number
  /**
   * Updated time.
   * @type {string}
   * @memberof CovidInfo
   */
  updated?: string
}
/**
 *
 * @export
 * @interface CryptoCandles
 */
export interface CryptoCandles {
  /**
   * List of open prices for returned candles.
   * @type {Array<number>}
   * @memberof CryptoCandles
   */
  o?: Array<number>
  /**
   * List of high prices for returned candles.
   * @type {Array<number>}
   * @memberof CryptoCandles
   */
  h?: Array<number>
  /**
   * List of low prices for returned candles.
   * @type {Array<number>}
   * @memberof CryptoCandles
   */
  l?: Array<number>
  /**
   * List of close prices for returned candles.
   * @type {Array<number>}
   * @memberof CryptoCandles
   */
  c?: Array<number>
  /**
   * List of volume data for returned candles.
   * @type {Array<number>}
   * @memberof CryptoCandles
   */
  v?: Array<number>
  /**
   * List of timestamp for returned candles.
   * @type {Array<number>}
   * @memberof CryptoCandles
   */
  t?: Array<number>
  /**
   * Status of the response. This field can either be ok or no_data.
   * @type {string}
   * @memberof CryptoCandles
   */
  s?: string
}
/**
 *
 * @export
 * @interface CryptoProfile
 */
export interface CryptoProfile {
  /**
   * Long name.
   * @type {string}
   * @memberof CryptoProfile
   */
  longName?: string
  /**
   * Name.
   * @type {string}
   * @memberof CryptoProfile
   */
  name?: string
  /**
   * Description.
   * @type {string}
   * @memberof CryptoProfile
   */
  description?: string
  /**
   * Project\'s website.
   * @type {string}
   * @memberof CryptoProfile
   */
  website?: string
  /**
   * Market capitalization.
   * @type {number}
   * @memberof CryptoProfile
   */
  marketCap?: number
  /**
   * Total supply.
   * @type {number}
   * @memberof CryptoProfile
   */
  totalSupply?: number
  /**
   * Max supply.
   * @type {number}
   * @memberof CryptoProfile
   */
  maxSupply?: number
  /**
   * Circulating supply.
   * @type {number}
   * @memberof CryptoProfile
   */
  circulatingSupply?: number
  /**
   * Logo image.
   * @type {string}
   * @memberof CryptoProfile
   */
  logo?: string
  /**
   * Launch date.
   * @type {string}
   * @memberof CryptoProfile
   */
  launchDate?: string
  /**
   * Proof type.
   * @type {string}
   * @memberof CryptoProfile
   */
  proofType?: string
}
/**
 *
 * @export
 * @interface CryptoSymbol
 */
export interface CryptoSymbol {
  /**
   * Symbol description
   * @type {string}
   * @memberof CryptoSymbol
   */
  description?: string
  /**
   * Display symbol name.
   * @type {string}
   * @memberof CryptoSymbol
   */
  displaySymbol?: string
  /**
   * Unique symbol used to identify this symbol used in <code>/crypto/candle</code> endpoint.
   * @type {string}
   * @memberof CryptoSymbol
   */
  symbol?: string
}
/**
 *
 * @export
 * @interface Development
 */
export interface Development {
  /**
   * Company symbol.
   * @type {string}
   * @memberof Development
   */
  symbol?: string
  /**
   * Published time in <code>YYYY-MM-DD HH:MM:SS</code> format.
   * @type {string}
   * @memberof Development
   */
  datetime?: string
  /**
   * Development headline.
   * @type {string}
   * @memberof Development
   */
  headline?: string
  /**
   * Development description.
   * @type {string}
   * @memberof Development
   */
  description?: string
  /**
   * URL.
   * @type {string}
   * @memberof Development
   */
  url?: string
}
/**
 *
 * @export
 * @interface Dividends
 */
export interface Dividends {
  /**
   * Symbol.
   * @type {string}
   * @memberof Dividends
   */
  symbol?: string
  /**
   * Ex-Dividend date.
   * @type {string}
   * @memberof Dividends
   */
  date?: string
  /**
   * Amount in local currency.
   * @type {number}
   * @memberof Dividends
   */
  amount?: number
  /**
   * Adjusted dividend.
   * @type {number}
   * @memberof Dividends
   */
  adjustedAmount?: number
  /**
   * Pay date.
   * @type {string}
   * @memberof Dividends
   */
  payDate?: string
  /**
   * Record date.
   * @type {string}
   * @memberof Dividends
   */
  recordDate?: string
  /**
   * Declaration date.
   * @type {string}
   * @memberof Dividends
   */
  declarationDate?: string
  /**
   * Currency.
   * @type {string}
   * @memberof Dividends
   */
  currency?: string
}
/**
 *
 * @export
 * @interface Dividends2
 */
export interface Dividends2 {
  /**
   * Symbol
   * @type {string}
   * @memberof Dividends2
   */
  symbol?: string
  /**
   *
   * @type {Array<Dividends2Info>}
   * @memberof Dividends2
   */
  data?: Array<Dividends2Info>
}
/**
 *
 * @export
 * @interface Dividends2Info
 */
export interface Dividends2Info {
  /**
   * Ex-Dividend date.
   * @type {string}
   * @memberof Dividends2Info
   */
  exDate?: string
  /**
   * Amount in local currency.
   * @type {number}
   * @memberof Dividends2Info
   */
  amount?: number
}
/**
 *
 * @export
 * @interface ETFCountryExposureData
 */
export interface ETFCountryExposureData {
  /**
   * Country
   * @type {string}
   * @memberof ETFCountryExposureData
   */
  country?: string
  /**
   * Percent of exposure.
   * @type {number}
   * @memberof ETFCountryExposureData
   */
  exposure?: number
}
/**
 *
 * @export
 * @interface ETFHoldingsData
 */
export interface ETFHoldingsData {
  /**
   * Symbol description
   * @type {string}
   * @memberof ETFHoldingsData
   */
  symbol?: string
  /**
   * Security name
   * @type {string}
   * @memberof ETFHoldingsData
   */
  name?: string
  /**
   * ISIN.
   * @type {string}
   * @memberof ETFHoldingsData
   */
  isin?: string
  /**
   * CUSIP.
   * @type {string}
   * @memberof ETFHoldingsData
   */
  cusip?: string
  /**
   * Number of shares owned by the ETF.
   * @type {number}
   * @memberof ETFHoldingsData
   */
  share?: number
  /**
   * Portfolio\'s percent
   * @type {number}
   * @memberof ETFHoldingsData
   */
  percent?: number
  /**
   * Market value
   * @type {number}
   * @memberof ETFHoldingsData
   */
  value?: number
}
/**
 *
 * @export
 * @interface ETFProfileData
 */
export interface ETFProfileData {
  /**
   * Name
   * @type {string}
   * @memberof ETFProfileData
   */
  name?: string
  /**
   * Asset Class.
   * @type {string}
   * @memberof ETFProfileData
   */
  assetClass?: string
  /**
   * Investment Segment.
   * @type {string}
   * @memberof ETFProfileData
   */
  investmentSegment?: string
  /**
   * AUM.
   * @type {number}
   * @memberof ETFProfileData
   */
  aum?: number
  /**
   * NAV.
   * @type {number}
   * @memberof ETFProfileData
   */
  nav?: number
  /**
   * NAV currency.
   * @type {string}
   * @memberof ETFProfileData
   */
  navCurrency?: string
  /**
   * Expense ratio.
   * @type {number}
   * @memberof ETFProfileData
   */
  expenseRatio?: number
  /**
   * Tracking Index.
   * @type {string}
   * @memberof ETFProfileData
   */
  trackingIndex?: string
  /**
   * ETF issuer.
   * @type {string}
   * @memberof ETFProfileData
   */
  etfCompany?: string
  /**
   * ETF domicile.
   * @type {string}
   * @memberof ETFProfileData
   */
  domicile?: string
  /**
   * Inception date.
   * @type {string}
   * @memberof ETFProfileData
   */
  inceptionDate?: string
  /**
   * ETF\'s website.
   * @type {string}
   * @memberof ETFProfileData
   */
  website?: string
  /**
   * ISIN.
   * @type {string}
   * @memberof ETFProfileData
   */
  isin?: string
  /**
   * CUSIP.
   * @type {string}
   * @memberof ETFProfileData
   */
  cusip?: string
  /**
   * P/E.
   * @type {number}
   * @memberof ETFProfileData
   */
  priceToEarnings?: number
  /**
   * P/B.
   * @type {number}
   * @memberof ETFProfileData
   */
  priceToBook?: number
  /**
   * 30-day average volume.
   * @type {number}
   * @memberof ETFProfileData
   */
  avgVolume?: number
  /**
   * ETF\'s description.
   * @type {string}
   * @memberof ETFProfileData
   */
  description?: string
}
/**
 *
 * @export
 * @interface ETFSectorExposureData
 */
export interface ETFSectorExposureData {
  /**
   * Industry
   * @type {string}
   * @memberof ETFSectorExposureData
   */
  industry?: string
  /**
   * Percent of exposure.
   * @type {number}
   * @memberof ETFSectorExposureData
   */
  exposure?: number
}
/**
 *
 * @export
 * @interface ETFsCountryExposure
 */
export interface ETFsCountryExposure {
  /**
   * ETF symbol.
   * @type {string}
   * @memberof ETFsCountryExposure
   */
  symbol?: string
  /**
   * Array of countries and and exposure levels.
   * @type {Array<ETFCountryExposureData>}
   * @memberof ETFsCountryExposure
   */
  countryExposure?: Array<ETFCountryExposureData>
}
/**
 *
 * @export
 * @interface ETFsHoldings
 */
export interface ETFsHoldings {
  /**
   * ETF symbol.
   * @type {string}
   * @memberof ETFsHoldings
   */
  symbol?: string
  /**
   * Holdings update date.
   * @type {string}
   * @memberof ETFsHoldings
   */
  atDate?: string
  /**
   * Number of holdings.
   * @type {number}
   * @memberof ETFsHoldings
   */
  numberOfHoldings?: number
  /**
   * Array of holdings.
   * @type {Array<ETFHoldingsData>}
   * @memberof ETFsHoldings
   */
  holdings?: Array<ETFHoldingsData>
}
/**
 *
 * @export
 * @interface ETFsProfile
 */
export interface ETFsProfile {
  /**
   * Symbol.
   * @type {string}
   * @memberof ETFsProfile
   */
  symbol?: string
  /**
   *
   * @type {ETFProfileData}
   * @memberof ETFsProfile
   */
  profile?: ETFProfileData
}
/**
 *
 * @export
 * @interface ETFsSectorExposure
 */
export interface ETFsSectorExposure {
  /**
   * ETF symbol.
   * @type {string}
   * @memberof ETFsSectorExposure
   */
  symbol?: string
  /**
   * Array of industries and exposure levels.
   * @type {Array<ETFSectorExposureData>}
   * @memberof ETFsSectorExposure
   */
  sectorExposure?: Array<ETFSectorExposureData>
}
/**
 *
 * @export
 * @interface EarningRelease
 */
export interface EarningRelease {
  /**
   * Symbol.
   * @type {string}
   * @memberof EarningRelease
   */
  symbol?: string
  /**
   * Date.
   * @type {string}
   * @memberof EarningRelease
   */
  date?: string
  /**
   * Indicates whether the earnings is announced before market open(<code>bmo</code>), after market close(<code>amc</code>), or during market hour(<code>dmh</code>).
   * @type {string}
   * @memberof EarningRelease
   */
  hour?: string
  /**
   * Earnings year.
   * @type {number}
   * @memberof EarningRelease
   */
  year?: number
  /**
   * Earnings quarter.
   * @type {number}
   * @memberof EarningRelease
   */
  quarter?: number
  /**
   * EPS estimate.
   * @type {number}
   * @memberof EarningRelease
   */
  epsEstimate?: number
  /**
   * EPS actual.
   * @type {number}
   * @memberof EarningRelease
   */
  epsActual?: number
  /**
   * Revenue estimate including Finnhub\'s proprietary estimates.
   * @type {number}
   * @memberof EarningRelease
   */
  revenueEstimate?: number
  /**
   * Revenue actual.
   * @type {number}
   * @memberof EarningRelease
   */
  revenueActual?: number
}
/**
 *
 * @export
 * @interface EarningResult
 */
export interface EarningResult {
  /**
   * Actual earning result.
   * @type {number}
   * @memberof EarningResult
   */
  actual?: number
  /**
   * Estimated earning.
   * @type {number}
   * @memberof EarningResult
   */
  estimate?: number
  /**
   * Surprise - The difference between actual and estimate.
   * @type {number}
   * @memberof EarningResult
   */
  surprise?: number
  /**
   * Surprise percent.
   * @type {number}
   * @memberof EarningResult
   */
  surprisePercent?: number
  /**
   * Reported period.
   * @type {string}
   * @memberof EarningResult
   */
  period?: string
  /**
   * Company symbol.
   * @type {string}
   * @memberof EarningResult
   */
  symbol?: string
}
/**
 *
 * @export
 * @interface EarningsCalendar
 */
export interface EarningsCalendar {
  /**
   * Array of earnings release.
   * @type {Array<EarningRelease>}
   * @memberof EarningsCalendar
   */
  earningsCalendar?: Array<EarningRelease>
}
/**
 *
 * @export
 * @interface EarningsCallTranscripts
 */
export interface EarningsCallTranscripts {
  /**
   * Company symbol.
   * @type {string}
   * @memberof EarningsCallTranscripts
   */
  symbol?: string
  /**
   * Transcript content.
   * @type {Array<TranscriptContent>}
   * @memberof EarningsCallTranscripts
   */
  transcript?: Array<TranscriptContent>
  /**
   * Participant list
   * @type {Array<TranscriptParticipant>}
   * @memberof EarningsCallTranscripts
   */
  participant?: Array<TranscriptParticipant>
  /**
   * Audio link.
   * @type {string}
   * @memberof EarningsCallTranscripts
   */
  audio?: string
  /**
   * Transcript\'s ID.
   * @type {string}
   * @memberof EarningsCallTranscripts
   */
  id?: string
  /**
   * Title.
   * @type {string}
   * @memberof EarningsCallTranscripts
   */
  title?: string
  /**
   * Time of the event.
   * @type {string}
   * @memberof EarningsCallTranscripts
   */
  time?: string
  /**
   * Year of earnings result in the case of earnings call transcript.
   * @type {number}
   * @memberof EarningsCallTranscripts
   */
  year?: number
  /**
   * Quarter of earnings result in the case of earnings call transcript.
   * @type {number}
   * @memberof EarningsCallTranscripts
   */
  quarter?: number
}
/**
 *
 * @export
 * @interface EarningsCallTranscriptsList
 */
export interface EarningsCallTranscriptsList {
  /**
   * Company symbol.
   * @type {string}
   * @memberof EarningsCallTranscriptsList
   */
  symbol?: string
  /**
   * Array of transcripts\' metadata
   * @type {Array<StockTranscripts>}
   * @memberof EarningsCallTranscriptsList
   */
  transcripts?: Array<StockTranscripts>
}
/**
 *
 * @export
 * @interface EarningsEstimates
 */
export interface EarningsEstimates {
  /**
   * List of estimates
   * @type {Array<EarningsEstimatesInfo>}
   * @memberof EarningsEstimates
   */
  data?: Array<EarningsEstimatesInfo>
  /**
   * Frequency: annual or quarterly.
   * @type {string}
   * @memberof EarningsEstimates
   */
  freq?: string
  /**
   * Company symbol.
   * @type {string}
   * @memberof EarningsEstimates
   */
  symbol?: string
}
/**
 *
 * @export
 * @interface EarningsEstimatesInfo
 */
export interface EarningsEstimatesInfo {
  /**
   * Average EPS estimates including Finnhub\'s proprietary estimates.
   * @type {number}
   * @memberof EarningsEstimatesInfo
   */
  epsAvg?: number
  /**
   * Highest estimate.
   * @type {number}
   * @memberof EarningsEstimatesInfo
   */
  epsHigh?: number
  /**
   * Lowest estimate.
   * @type {number}
   * @memberof EarningsEstimatesInfo
   */
  epsLow?: number
  /**
   * Number of Analysts.
   * @type {number}
   * @memberof EarningsEstimatesInfo
   */
  numberAnalysts?: number
  /**
   * Period.
   * @type {string}
   * @memberof EarningsEstimatesInfo
   */
  period?: string
}
/**
 *
 * @export
 * @interface EbitEstimates
 */
export interface EbitEstimates {
  /**
   * List of estimates
   * @type {Array<EbitEstimatesInfo>}
   * @memberof EbitEstimates
   */
  data?: Array<EbitEstimatesInfo>
  /**
   * Frequency: annual or quarterly.
   * @type {string}
   * @memberof EbitEstimates
   */
  freq?: string
  /**
   * Company symbol.
   * @type {string}
   * @memberof EbitEstimates
   */
  symbol?: string
}
/**
 *
 * @export
 * @interface EbitEstimatesInfo
 */
export interface EbitEstimatesInfo {
  /**
   * Average EBIT estimates including Finnhub\'s proprietary estimates.
   * @type {number}
   * @memberof EbitEstimatesInfo
   */
  ebitAvg?: number
  /**
   * Highest estimate.
   * @type {number}
   * @memberof EbitEstimatesInfo
   */
  ebitHigh?: number
  /**
   * Lowest estimate.
   * @type {number}
   * @memberof EbitEstimatesInfo
   */
  ebitLow?: number
  /**
   * Number of Analysts.
   * @type {number}
   * @memberof EbitEstimatesInfo
   */
  numberAnalysts?: number
  /**
   * Period.
   * @type {string}
   * @memberof EbitEstimatesInfo
   */
  period?: string
}
/**
 *
 * @export
 * @interface EbitdaEstimates
 */
export interface EbitdaEstimates {
  /**
   * List of estimates
   * @type {Array<EbitdaEstimatesInfo>}
   * @memberof EbitdaEstimates
   */
  data?: Array<EbitdaEstimatesInfo>
  /**
   * Frequency: annual or quarterly.
   * @type {string}
   * @memberof EbitdaEstimates
   */
  freq?: string
  /**
   * Company symbol.
   * @type {string}
   * @memberof EbitdaEstimates
   */
  symbol?: string
}
/**
 *
 * @export
 * @interface EbitdaEstimatesInfo
 */
export interface EbitdaEstimatesInfo {
  /**
   * Average EBITDA estimates including Finnhub\'s proprietary estimates.
   * @type {number}
   * @memberof EbitdaEstimatesInfo
   */
  ebitdaAvg?: number
  /**
   * Highest estimate.
   * @type {number}
   * @memberof EbitdaEstimatesInfo
   */
  ebitdaHigh?: number
  /**
   * Lowest estimate.
   * @type {number}
   * @memberof EbitdaEstimatesInfo
   */
  ebitdaLow?: number
  /**
   * Number of Analysts.
   * @type {number}
   * @memberof EbitdaEstimatesInfo
   */
  numberAnalysts?: number
  /**
   * Period.
   * @type {string}
   * @memberof EbitdaEstimatesInfo
   */
  period?: string
}
/**
 *
 * @export
 * @interface Economic event
 */
export interface Economic {
  /**
   * Actual release
   * @type {number}
   * @memberof Economic event
   */
  actual?: number
  /**
   * Previous release
   * @type {number}
   * @memberof Economic event
   */
  prev?: number
  /**
   * Country
   * @type {string}
   * @memberof Economic event
   */
  country?: string
  /**
   * Unit
   * @type {string}
   * @memberof Economic event
   */
  unit?: string
  /**
   * Estimate
   * @type {number}
   * @memberof Economic event
   */
  estimate?: number
  /**
   * Event
   * @type {string}
   * @memberof Economic event
   */
  event?: string
  /**
   * Impact level
   * @type {string}
   * @memberof Economic event
   */
  impact?: string
  /**
   * Release time
   * @type {string}
   * @memberof Economic event
   */
  time?: string
}
/**
 *
 * @export
 * @interface EconomicCalendar
 */
export interface EconomicCalendar {
  /**
   * Array of economic events.
   * @type {Array<Economic event>}
   * @memberof EconomicCalendar
   */
  economicCalendar?: Array<Economic>
}
/**
 *
 * @export
 * @interface EconomicCode
 */
export interface EconomicCode {
  /**
   * Finnhub economic code used to get historical data
   * @type {string}
   * @memberof EconomicCode
   */
  code?: string
  /**
   * Country
   * @type {string}
   * @memberof EconomicCode
   */
  country?: string
  /**
   * Indicator name
   * @type {string}
   * @memberof EconomicCode
   */
  name?: string
  /**
   * Unit
   * @type {string}
   * @memberof EconomicCode
   */
  unit?: string
}
/**
 *
 * @export
 * @interface EconomicData
 */
export interface EconomicData {
  /**
   * Array of economic data for requested code.
   * @type {Array<EconomicDataInfo>}
   * @memberof EconomicData
   */
  data?: Array<EconomicDataInfo>
  /**
   * Finnhub economic code
   * @type {string}
   * @memberof EconomicData
   */
  code?: string
}
/**
 *
 * @export
 * @interface EconomicDataInfo
 */
export interface EconomicDataInfo {
  /**
   * Date of the reading
   * @type {string}
   * @memberof EconomicDataInfo
   */
  date?: string
  /**
   * Value
   * @type {number}
   * @memberof EconomicDataInfo
   */
  value?: number
}
/**
 *
 * @export
 * @interface FDAComitteeMeeting
 */
export interface FDAComitteeMeeting {
  /**
   * Start time of the event in EST.
   * @type {string}
   * @memberof FDAComitteeMeeting
   */
  fromDate?: string
  /**
   * End time of the event in EST.
   * @type {string}
   * @memberof FDAComitteeMeeting
   */
  toDate?: string
  /**
   * Event\'s description.
   * @type {string}
   * @memberof FDAComitteeMeeting
   */
  eventDescription?: string
  /**
   * URL.
   * @type {string}
   * @memberof FDAComitteeMeeting
   */
  url?: string
}
/**
 *
 * @export
 * @interface Filing
 */
export interface Filing {
  /**
   * Access number.
   * @type {string}
   * @memberof Filing
   */
  accessNumber?: string
  /**
   * Symbol.
   * @type {string}
   * @memberof Filing
   */
  symbol?: string
  /**
   * CIK.
   * @type {string}
   * @memberof Filing
   */
  cik?: string
  /**
   * Form type.
   * @type {string}
   * @memberof Filing
   */
  form?: string
  /**
   * Filed date <code>%Y-%m-%d %H:%M:%S</code>.
   * @type {string}
   * @memberof Filing
   */
  filedDate?: string
  /**
   * Accepted date <code>%Y-%m-%d %H:%M:%S</code>.
   * @type {string}
   * @memberof Filing
   */
  acceptedDate?: string
  /**
   * Report\'s URL.
   * @type {string}
   * @memberof Filing
   */
  reportUrl?: string
  /**
   * Filing\'s URL.
   * @type {string}
   * @memberof Filing
   */
  filingUrl?: string
}
/**
 *
 * @export
 * @interface FilingSentiment
 */
export interface FilingSentiment {
  /**
   * % of negative words in the filing.
   * @type {number}
   * @memberof FilingSentiment
   */
  negative?: number
  /**
   * % of positive words in the filing.
   * @type {number}
   * @memberof FilingSentiment
   */
  positive?: number
  /**
   * % of polarity words in the filing.
   * @type {number}
   * @memberof FilingSentiment
   */
  polarity?: number
  /**
   * % of litigious words in the filing.
   * @type {number}
   * @memberof FilingSentiment
   */
  litigious?: number
  /**
   * % of uncertainty words in the filing.
   * @type {number}
   * @memberof FilingSentiment
   */
  uncertainty?: number
  /**
   * % of constraining words in the filing.
   * @type {number}
   * @memberof FilingSentiment
   */
  constraining?: number
  /**
   * % of modal-weak words in the filing.
   * @type {number}
   * @memberof FilingSentiment
   */
  'modal-weak'?: number
  /**
   * % of modal-strong words in the filing.
   * @type {number}
   * @memberof FilingSentiment
   */
  'modal-strong'?: number
  /**
   * % of modal-moderate words in the filing.
   * @type {number}
   * @memberof FilingSentiment
   */
  'modal-moderate'?: number
}
/**
 *
 * @export
 * @interface FinancialStatements
 */
export interface FinancialStatements {
  /**
   * Symbol of the company.
   * @type {string}
   * @memberof FinancialStatements
   */
  symbol?: string
  /**
   * An array of map of key, value pairs containing the data for each period.
   * @type {Array<object>}
   * @memberof FinancialStatements
   */
  financials?: Array<object>
}
/**
 *
 * @export
 * @interface FinancialsAsReported
 */
export interface FinancialsAsReported {
  /**
   * Symbol
   * @type {string}
   * @memberof FinancialsAsReported
   */
  symbol?: string
  /**
   * CIK
   * @type {string}
   * @memberof FinancialsAsReported
   */
  cik?: string
  /**
   * Array of filings.
   * @type {Array<Report>}
   * @memberof FinancialsAsReported
   */
  data?: Array<Report>
}
/**
 *
 * @export
 * @interface ForexCandles
 */
export interface ForexCandles {
  /**
   * List of open prices for returned candles.
   * @type {Array<number>}
   * @memberof ForexCandles
   */
  o?: Array<number>
  /**
   * List of high prices for returned candles.
   * @type {Array<number>}
   * @memberof ForexCandles
   */
  h?: Array<number>
  /**
   * List of low prices for returned candles.
   * @type {Array<number>}
   * @memberof ForexCandles
   */
  l?: Array<number>
  /**
   * List of close prices for returned candles.
   * @type {Array<number>}
   * @memberof ForexCandles
   */
  c?: Array<number>
  /**
   * List of volume data for returned candles.
   * @type {Array<number>}
   * @memberof ForexCandles
   */
  v?: Array<number>
  /**
   * List of timestamp for returned candles.
   * @type {Array<number>}
   * @memberof ForexCandles
   */
  t?: Array<number>
  /**
   * Status of the response. This field can either be ok or no_data.
   * @type {string}
   * @memberof ForexCandles
   */
  s?: string
}
/**
 *
 * @export
 * @interface ForexSymbol
 */
export interface ForexSymbol {
  /**
   * Symbol description
   * @type {string}
   * @memberof ForexSymbol
   */
  description?: string
  /**
   * Display symbol name.
   * @type {string}
   * @memberof ForexSymbol
   */
  displaySymbol?: string
  /**
   * Unique symbol used to identify this symbol used in <code>/forex/candle</code> endpoint.
   * @type {string}
   * @memberof ForexSymbol
   */
  symbol?: string
}
/**
 *
 * @export
 * @interface Forexrates
 */
export interface Forexrates {
  /**
   * Base currency.
   * @type {string}
   * @memberof Forexrates
   */
  base?: string
  /**
   *
   * @type {object}
   * @memberof Forexrates
   */
  quote?: object
}
/**
 *
 * @export
 * @interface FundOwnership
 */
export interface FundOwnership {
  /**
   * Symbol of the company.
   * @type {string}
   * @memberof FundOwnership
   */
  symbol?: string
  /**
   * Array of investors with detailed information about their holdings.
   * @type {Array<FundOwnershipInfo>}
   * @memberof FundOwnership
   */
  ownership?: Array<FundOwnershipInfo>
}
/**
 *
 * @export
 * @interface FundOwnershipInfo
 */
export interface FundOwnershipInfo {
  /**
   * Investor\'s name.
   * @type {string}
   * @memberof FundOwnershipInfo
   */
  name?: string
  /**
   * Number of shares held by the investor.
   * @type {number}
   * @memberof FundOwnershipInfo
   */
  share?: number
  /**
   * Number of share changed (net buy or sell) from the last period.
   * @type {number}
   * @memberof FundOwnershipInfo
   */
  change?: number
  /**
   * Filing date.
   * @type {string}
   * @memberof FundOwnershipInfo
   */
  filingDate?: string
  /**
   * Percent of the fund\'s portfolio comprised of the company\'s share.
   * @type {number}
   * @memberof FundOwnershipInfo
   */
  portfolioPercent?: number
}
/**
 *
 * @export
 * @interface HistoricalNBBO
 */
export interface HistoricalNBBO {
  /**
   * Symbol.
   * @type {string}
   * @memberof HistoricalNBBO
   */
  s?: string
  /**
   * Number of ticks skipped.
   * @type {number}
   * @memberof HistoricalNBBO
   */
  skip?: number
  /**
   * Number of ticks returned. If <code>count</code> < <code>limit</code>, all data for that date has been returned.
   * @type {number}
   * @memberof HistoricalNBBO
   */
  count?: number
  /**
   * Total number of ticks for that date.
   * @type {number}
   * @memberof HistoricalNBBO
   */
  total?: number
  /**
   * List of Ask volume data.
   * @type {Array<number>}
   * @memberof HistoricalNBBO
   */
  av?: Array<number>
  /**
   * List of Ask price data.
   * @type {Array<number>}
   * @memberof HistoricalNBBO
   */
  a?: Array<number>
  /**
   * List of venues/exchanges - Ask price. A list of exchange codes can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1Tj53M1svmr-hfEtbk6_NpVR1yAyGLMaH6ByYU6CG0ZY/edit?usp=sharing\",>here</a>
   * @type {Array<string>}
   * @memberof HistoricalNBBO
   */
  ax?: Array<string>
  /**
   * List of Bid volume data.
   * @type {Array<number>}
   * @memberof HistoricalNBBO
   */
  bv?: Array<number>
  /**
   * List of Bid price data.
   * @type {Array<number>}
   * @memberof HistoricalNBBO
   */
  b?: Array<number>
  /**
   * List of venues/exchanges - Bid price. A list of exchange codes can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1Tj53M1svmr-hfEtbk6_NpVR1yAyGLMaH6ByYU6CG0ZY/edit?usp=sharing\",>here</a>
   * @type {Array<string>}
   * @memberof HistoricalNBBO
   */
  bx?: Array<string>
  /**
   * List of timestamp in UNIX ms.
   * @type {Array<number>}
   * @memberof HistoricalNBBO
   */
  t?: Array<number>
  /**
   * List of quote conditions. A comprehensive list of quote conditions code can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1iiA6e7Osdtai0oPMOUzgAIKXCsay89dFDmsegz6OpEg/edit?usp=sharing\">here</a>
   * @type {Array<Array<string>>}
   * @memberof HistoricalNBBO
   */
  c?: Array<Array<string>>
}
/**
 *
 * @export
 * @interface IPOCalendar
 */
export interface IPOCalendar {
  /**
   * Array of IPO events.
   * @type {Array<IPOEvent>}
   * @memberof IPOCalendar
   */
  ipoCalendar?: Array<IPOEvent>
}
/**
 *
 * @export
 * @interface IPOEvent
 */
export interface IPOEvent {
  /**
   * Symbol.
   * @type {string}
   * @memberof IPOEvent
   */
  symbol?: string
  /**
   * IPO date.
   * @type {string}
   * @memberof IPOEvent
   */
  date?: string
  /**
   * Exchange.
   * @type {string}
   * @memberof IPOEvent
   */
  exchange?: string
  /**
   * Company\'s name.
   * @type {string}
   * @memberof IPOEvent
   */
  name?: string
  /**
   * IPO status. Can take 1 of the following values: <code>expected</code>,<code>priced</code>,<code>withdrawn</code>,<code>filed</code>
   * @type {string}
   * @memberof IPOEvent
   */
  status?: string
  /**
   * Projected price or price range.
   * @type {string}
   * @memberof IPOEvent
   */
  price?: string
  /**
   * Number of shares offered during the IPO.
   * @type {number}
   * @memberof IPOEvent
   */
  numberOfShares?: number
  /**
   * Total shares value.
   * @type {number}
   * @memberof IPOEvent
   */
  totalSharesValue?: number
}
/**
 *
 * @export
 * @interface IndexHistoricalConstituent
 */
export interface IndexHistoricalConstituent {
  /**
   * Symbol
   * @type {string}
   * @memberof IndexHistoricalConstituent
   */
  symbol?: string
  /**
   * <code>add</code> or <code>remove</code>.
   * @type {string}
   * @memberof IndexHistoricalConstituent
   */
  action?: string
  /**
   * Date of joining or leaving the index.
   * @type {string}
   * @memberof IndexHistoricalConstituent
   */
  date?: string
}
/**
 *
 * @export
 * @interface Indicator
 */
export interface Indicator {
  /**
   * Number of buy signals
   * @type {number}
   * @memberof Indicator
   */
  buy?: number
  /**
   * Number of neutral signals
   * @type {number}
   * @memberof Indicator
   */
  neutral?: number
  /**
   * Number of sell signals
   * @type {number}
   * @memberof Indicator
   */
  sell?: number
}
/**
 *
 * @export
 * @interface IndicesConstituents
 */
export interface IndicesConstituents {
  /**
   * Index\'s symbol.
   * @type {string}
   * @memberof IndicesConstituents
   */
  symbol?: string
  /**
   * Array of constituents.
   * @type {Array<string>}
   * @memberof IndicesConstituents
   */
  constituents?: Array<string>
}
/**
 *
 * @export
 * @interface IndicesHistoricalConstituents
 */
export interface IndicesHistoricalConstituents {
  /**
   * Index\'s symbol.
   * @type {string}
   * @memberof IndicesHistoricalConstituents
   */
  symbol?: string
  /**
   * Array of historical constituents.
   * @type {Array<IndexHistoricalConstituent>}
   * @memberof IndicesHistoricalConstituents
   */
  historicalConstituents?: Array<IndexHistoricalConstituent>
}
/**
 *
 * @export
 * @interface InsiderSentiments
 */
export interface InsiderSentiments {
  /**
   * Symbol of the company.
   * @type {string}
   * @memberof InsiderSentiments
   */
  symbol?: string
  /**
   * Array of sentiment data.
   * @type {Array<InsiderSentimentsData>}
   * @memberof InsiderSentiments
   */
  data?: Array<InsiderSentimentsData>
}
/**
 *
 * @export
 * @interface InsiderSentimentsData
 */
export interface InsiderSentimentsData {
  /**
   * Symbol.
   * @type {string}
   * @memberof InsiderSentimentsData
   */
  symbol?: string
  /**
   * Year.
   * @type {number}
   * @memberof InsiderSentimentsData
   */
  year?: number
  /**
   * Month.
   * @type {number}
   * @memberof InsiderSentimentsData
   */
  month?: number
  /**
   * Net buying/selling from all insiders\' transactions.
   * @type {number}
   * @memberof InsiderSentimentsData
   */
  change?: number
  /**
   * Monthly share purchase ratio.
   * @type {number}
   * @memberof InsiderSentimentsData
   */
  mspr?: number
}
/**
 *
 * @export
 * @interface InsiderTransactions
 */
export interface InsiderTransactions {
  /**
   * Symbol of the company.
   * @type {string}
   * @memberof InsiderTransactions
   */
  symbol?: string
  /**
   * Array of insider transactions.
   * @type {Array<Transactions>}
   * @memberof InsiderTransactions
   */
  data?: Array<Transactions>
}
/**
 *
 * @export
 * @interface InternationalFiling
 */
export interface InternationalFiling {
  /**
   * Symbol.
   * @type {string}
   * @memberof InternationalFiling
   */
  symbol?: string
  /**
   * Company name.
   * @type {string}
   * @memberof InternationalFiling
   */
  companyName?: string
  /**
   * Filed date <code>%Y-%m-%d %H:%M:%S</code>.
   * @type {string}
   * @memberof InternationalFiling
   */
  filedDate?: string
  /**
   * Category.
   * @type {string}
   * @memberof InternationalFiling
   */
  category?: string
  /**
   * Document\'s title.
   * @type {string}
   * @memberof InternationalFiling
   */
  title?: string
  /**
   * Document\'s description.
   * @type {string}
   * @memberof InternationalFiling
   */
  description?: string
  /**
   * Url.
   * @type {string}
   * @memberof InternationalFiling
   */
  url?: string
  /**
   * Language.
   * @type {string}
   * @memberof InternationalFiling
   */
  language?: string
  /**
   * Country.
   * @type {string}
   * @memberof InternationalFiling
   */
  country?: string
}
/**
 *
 * @export
 * @interface InvestmentThemePortfolio
 */
export interface InvestmentThemePortfolio {
  /**
   * Symbol
   * @type {string}
   * @memberof InvestmentThemePortfolio
   */
  symbol?: string
}
/**
 *
 * @export
 * @interface InvestmentThemes
 */
export interface InvestmentThemes {
  /**
   * Investment theme
   * @type {string}
   * @memberof InvestmentThemes
   */
  theme?: string
  /**
   * Investment theme portfolio.
   * @type {Array<InvestmentThemePortfolio>}
   * @memberof InvestmentThemes
   */
  data?: Array<InvestmentThemePortfolio>
}
/**
 *
 * @export
 * @interface KeyCustomersSuppliers
 */
export interface KeyCustomersSuppliers {
  /**
   * Symbol
   * @type {string}
   * @memberof KeyCustomersSuppliers
   */
  symbol?: string
  /**
   * Name
   * @type {string}
   * @memberof KeyCustomersSuppliers
   */
  name?: string
  /**
   * Country
   * @type {string}
   * @memberof KeyCustomersSuppliers
   */
  country?: string
  /**
   * Industry
   * @type {string}
   * @memberof KeyCustomersSuppliers
   */
  industry?: string
  /**
   * Whether the company is a customer.
   * @type {boolean}
   * @memberof KeyCustomersSuppliers
   */
  customer?: boolean
  /**
   * Whether the company is a supplier
   * @type {boolean}
   * @memberof KeyCustomersSuppliers
   */
  supplier?: boolean
  /**
   * 1-month price correlation
   * @type {number}
   * @memberof KeyCustomersSuppliers
   */
  oneMonthCorrelation?: number
  /**
   * 1-year price correlation
   * @type {number}
   * @memberof KeyCustomersSuppliers
   */
  oneYearCorrelation?: number
  /**
   * 6-month price correlation
   * @type {number}
   * @memberof KeyCustomersSuppliers
   */
  sixMonthCorrelation?: number
  /**
   * 3