openapi: 3.0.1
info:
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  title: Finnhub API
  version: 1.0.0
servers:
- url: https://finnhub.io/api/v1
paths:
  /search:
    get:
      description: Search for best-matching symbols based on your query. You can input
        anything from symbol, security's name to ISIN and Cusip.
      operationId: symbol-search
      parameters:
      - description: Query text can be symbol, name, isin, or cusip.
        in: query
        name: q
        required: true
        schema:
          type: string
      - description: Exchange limit.
        in: query
        name: exchange
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SymbolLookup'
          description: successful operation
      security:
      - api_key: []
      summary: Symbol Lookup
      tags:
      - Default
  /stock/symbol:
    get:
      description: List supported stocks. We use the following symbology to identify
        stocks on Finnhub <code>Exchange_Ticker.Exchange_Code</code>. A list of supported
        exchange codes can be found <a href="https://docs.google.com/spreadsheets/d/1I3pBxjfXB056-g_JYf_6o3Rns3BV2kMGG1nCatb91ls/edit?usp=sharing"
        target="_blank">here</a>.
      operationId: stock-symbols
      parameters:
      - description: Exchange you want to get the list of symbols from. List of exchange
          codes can be found <a href="https://docs.google.com/spreadsheets/d/1I3pBxjfXB056-g_JYf_6o3Rns3BV2kMGG1nCatb91ls/edit?usp=sharing"
          target="_blank">here</a>.
        in: query
        name: exchange
        required: true
        schema:
          type: string
      - description: Filter by MIC code.
        in: query
        name: mic
        schema:
          type: string
      - description: Filter by security type used by OpenFigi standard.
        in: query
        name: securityType
        schema:
          type: string
      - description: Filter by currency.
        in: query
        name: currency
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/StockSymbol'
                type: array
          description: successful operation
      security:
      - api_key: []
      summary: Stock Symbol
      tags:
      - Default
  /stock/market-status:
    get:
      description: Get current market status for global exchanges (whether exchanges
        are open or close).
      operationId: market-status
      parameters:
      - description: Exchange code.
        in: query
        name: exchange
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketStatus'
          description: successful operation
      security:
      - api_key: []
      summary: Market Status
      tags:
      - Default
  /stock/market-holiday:
    get:
      description: Get a list of holidays for global exchanges.
      operationId: market-holiday
      parameters:
      - description: Exchange code.
        in: query
        name: exchange
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketHoliday'
          description: successful operation
      security:
      - api_key: []
      summary: Market Holiday
      tags:
      - Default
  /stock/profile:
    get:
      description: Get general information of a company. You can query by symbol,
        ISIN or CUSIP
      operationId: company-profile
      parameters:
      - description: 'Symbol of the company: AAPL e.g.'
        in: query
        name: symbol
        schema:
          type: string
      - description: ISIN
        in: query
        name: isin
        schema:
          type: string
      - description: CUSIP
        in: query
        name: cusip
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyProfile'
          description: successful operation
      security:
      - api_key: []
      summary: Company Profile
      tags:
      - Default
  /stock/profile2:
    get:
      description: Get general information of a company. You can query by symbol,
        ISIN or CUSIP. This is the free version of <a href="#company-profile">Company
        Profile</a>.
      operationId: company-profile2
      parameters:
      - description: 'Symbol of the company: AAPL e.g.'
        in: query
        name: symbol
        schema:
          type: string
      - description: ISIN
        in: query
        name: isin
        schema:
          type: string
      - description: CUSIP
        in: query
        name: cusip
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyProfile2'
          description: successful operation
      security:
      - api_key: []
      summary: Company Profile 2
      tags:
      - Default
  /stock/executive:
    get:
      description: Get a list of company's executives and members of the Board.
      operationId: company-executive
      parameters:
      - description: 'Symbol of the company: AAPL.'
        in: query
        name: symbol
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyExecutive'
          description: successful operation
      security:
      - api_key: []
      summary: Company Executive
      tags:
      - Default
  /news:
    get:
      description: Get latest market news.
      operationId: market-news
      parameters:
      - description: This parameter can be 1 of the following values <code>general,
          forex, crypto, merger</code>.
        in: query
        name: category
        required: true
        schema:
          type: string
      - description: Use this field to get only news after this ID. Default to 0
        in: query
        name: minId
        schema:
          format: int64
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/MarketNews'
                type: array
          description: successful operation
      security:
      - api_key: []
      summary: Market News
      tags:
      - Default
  /company-news:
    get:
      description: List latest company news by symbol. This endpoint is only available
        for North American companies.
      operationId: company-news
      parameters:
      - description: Company symbol.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: From date <code>YYYY-MM-DD</code>.
        in: query
        name: from
        required: true
        schema:
          format: date
          type: string
      - description: To date <code>YYYY-MM-DD</code>.
        in: query
        name: to
        required: true
        schema:
          format: date
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/CompanyNews'
                type: array
          description: successful operation
      security:
      - api_key: []
      summary: Company News
      tags:
      - Default
  /press-releases:
    get:
      description: <p>Get latest major press releases of a company. This data can
        be used to highlight the most significant events comprised of mostly press
        releases sourced from the exchanges, BusinessWire, AccessWire, GlobeNewswire,
        Newsfile, and PRNewswire.</p><p>Full-text press releases data is available
        for Enterprise clients. <a href="mailto:support@finnhub.io">Contact Us</a>
        to learn more.</p>
      operationId: press-releases
      parameters:
      - description: Company symbol.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: 'From time: 2020-01-01.'
        in: query
        name: from
        schema:
          format: date
          type: string
      - description: 'To time: 2020-01-05.'
        in: query
        name: to
        schema:
          format: date
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PressRelease'
          description: successful operation
      security:
      - api_key: []
      summary: Major Press Releases
      tags:
      - Default
  /news-sentiment:
    get:
      description: Get company's news sentiment and statistics. This endpoint is only
        available for US companies.
      operationId: news-sentiment
      parameters:
      - description: Company symbol.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NewsSentiment'
          description: successful operation
      security:
      - api_key: []
      summary: News Sentiment
      tags:
      - Default
  /stock/peers:
    get:
      description: Get company peers. Return a list of peers operating in the same
        country and sector/industry.
      operationId: company-peers
      parameters:
      - description: 'Symbol of the company: AAPL.'
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: 'Specify the grouping criteria for choosing peers.Supporter values:
          <code>sector</code>, <code>industry</code>, <code>subIndustry</code>. Default
          to <code>subIndustry</code>.'
        in: query
        name: grouping
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                items:
                  type: string
                type: array
          description: successful operation
      security:
      - api_key: []
      summary: Peers
      tags:
      - Default
  /stock/metric:
    get:
      description: Get company basic financials such as margin, P/E ratio, 52-week
        high/low etc.
      operationId: company-basic-financials
      parameters:
      - description: 'Symbol of the company: AAPL.'
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: Metric type. Can be 1 of the following values <code>all</code>
        in: query
        name: metric
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFinancials'
          description: successful operation
      security:
      - api_key: []
      summary: Basic Financials
      tags:
      - Default
  /stock/price-metric:
    get:
      description: Get company price performance statistics such as 52-week high/low,
        YTD return and much more.
      operationId: price-metrics
      parameters:
      - description: 'Symbol of the company: AAPL.'
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: Get data on a specific date in the past. The data is available
          weekly so your date will be automatically adjusted to the last day of that
          week.
        in: query
        name: date
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PriceMetrics'
          description: successful operation
      security:
      - api_key: []
      summary: Price Metrics
      tags:
      - Default
  /ca/symbol-change:
    get:
      description: Get a list of symbol changes for US-listed, EU-listed, NSE and
        ASX securities. Limit to 2000 events at a time.
      operationId: symbol-change
      parameters:
      - description: From date <code>YYYY-MM-DD</code>.
        in: query
        name: from
        required: true
        schema:
          type: string
      - description: To date <code>YYYY-MM-DD</code>.
        in: query
        name: to
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SymbolChange'
          description: successful operation
      security:
      - api_key: []
      summary: Symbol Change
      tags:
      - Default
  /ca/isin-change:
    get:
      description: Get a list of ISIN changes for EU-listed securities. Limit to 2000
        events at a time.
      operationId: isin-change
      parameters:
      - description: From date <code>YYYY-MM-DD</code>.
        in: query
        name: from
        required: true
        schema:
          type: string
      - description: To date <code>YYYY-MM-DD</code>.
        in: query
        name: to
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsinChange'
          description: successful operation
      security:
      - api_key: []
      summary: ISIN Change
      tags:
      - Default
  /stock/historical-market-cap:
    get:
      description: Get historical market cap data for global companies.
      operationId: historical-market-cap
      parameters:
      - description: Company symbol.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: From date <code>YYYY-MM-DD</code>.
        in: query
        name: from
        required: true
        schema:
          format: date
          type: string
      - description: To date <code>YYYY-MM-DD</code>.
        in: query
        name: to
        required: true
        schema:
          format: date
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HistoricalMarketCapData'
          description: successful operation
      security:
      - api_key: []
      summary: Historical Market Cap
      tags:
      - Default
  /stock/historical-employee-count:
    get:
      description: Get historical employee count for global companies.
      operationId: historical-employee-count
      parameters:
      - description: Company symbol.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: From date <code>YYYY-MM-DD</code>.
        in: query
        name: from
        required: true
        schema:
          format: date
          type: string
      - description: To date <code>YYYY-MM-DD</code>.
        in: query
        name: to
        required: true
        schema:
          format: date
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HistoricalEmployeeCount'
          description: successful operation
      security:
      - api_key: []
      summary: Historical Employee Count
      tags:
      - Default
  /institutional/profile:
    get:
      description: Get a list of well-known institutional investors. Currently support
        60+ profiles.
      operationId: institutional-profile
      parameters:
      - description: Filter by CIK. Leave blank to get the full list.
        in: query
        name: cik
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstitutionalProfile'
          description: successful operation
      security:
      - api_key: []
      summary: Institutional Profile
      tags:
      - Default
  /institutional/portfolio:
    get:
      description: Get the holdings/portfolio data of institutional investors from
        13-F filings. Limit to 1 year of data at a time. You can get a list of supported
        CIK <a href="/api/v1/institutional/list?token=" target="_blank">here</a>.
      operationId: institutional-portfolio
      parameters:
      - description: Fund's CIK.
        in: query
        name: cik
        required: true
        schema:
          type: string
      - description: From date <code>YYYY-MM-DD</code>.
        in: query
        name: from
        required: true
        schema:
          type: string
      - description: To date <code>YYYY-MM-DD</code>.
        in: query
        name: to
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstitutionalPortfolio'
          description: successful operation
      security:
      - api_key: []
      summary: Institutional Portfolio
      tags:
      - Default
  /institutional/ownership:
    get:
      description: Get a list institutional investors' positions for a particular
        stock overtime. Data from 13-F filings. Limit to 1 year of data at a time.
      operationId: institutional-ownership
      parameters:
      - description: Filter by symbol.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: Filter by CUSIP.
        in: query
        name: cusip
        required: true
        schema:
          type: string
      - description: From date <code>YYYY-MM-DD</code>.
        in: query
        name: from
        required: true
        schema:
          type: string
      - description: To date <code>YYYY-MM-DD</code>.
        in: query
        name: to
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstitutionalOwnership'
          description: successful operation
      security:
      - api_key: []
      summary: Institutional Ownership
      tags:
      - Default
  /stock/ownership:
    get:
      description: Get a full list of shareholders of a company in descending order
        of the number of shares held. Data is sourced from <code>13F form</code>,
        <code>Schedule 13D</code> and <code>13G</code> for US market, <code>UK Share
        Register</code> for UK market, <code>SEDI</code> for Canadian market and equivalent
        filings for other international markets.
      operationId: ownership
      parameters:
      - description: 'Symbol of the company: AAPL.'
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: Limit number of results. Leave empty to get the full list.
        in: query
        name: limit
        schema:
          format: int64
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Ownership'
          description: successful operation
      security:
      - api_key: []
      summary: Ownership
      tags:
      - Default
  /stock/fund-ownership:
    get:
      description: Get a full list fund and institutional investors of a company in
        descending order of the number of shares held. Data is sourced from <code>13F
        form</code>, <code>Schedule 13D</code> and <code>13G</code> for US market,
        <code>UK Share Register</code> for UK market, <code>SEDI</code> for Canadian
        market and equivalent filings for other international markets.
      operationId: fund-ownership
      parameters:
      - description: 'Symbol of the company: AAPL.'
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: Limit number of results. Leave empty to get the full list.
        in: query
        name: limit
        schema:
          format: int64
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FundOwnership'
          description: successful operation
      security:
      - api_key: []
      summary: Fund Ownership
      tags:
      - Default
  /stock/insider-transactions:
    get:
      description: Company insider transactions data sourced from <code>Form 3,4,5</code>,
        SEDI and relevant companies' filings. This endpoint covers US, UK, Canada,
        Australia, India, and all major EU markets. Limit to 100 transactions per
        API call.
      operationId: insider-transactions
      parameters:
      - description: 'Symbol of the company: AAPL. Leave this param blank to get the
          latest transactions.'
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: 'From date: 2020-03-15.'
        in: query
        name: from
        schema:
          format: date
          type: string
      - description: 'To date: 2020-03-16.'
        in: query
        name: to
        schema:
          format: date
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsiderTransactions'
          description: successful operation
      security:
      - api_key: []
      summary: Insider Transactions
      tags:
      - Default
  /stock/insider-sentiment:
    get:
      description: Get insider sentiment data for US companies calculated using method
        discussed <a href="https://medium.com/@stock-api/finnhub-insiders-sentiment-analysis-cc43f9f64b3a"
        target="_blank">here</a>. The MSPR ranges from -100 for the most negative
        to 100 for the most positive which can signal price changes in the coming
        30-90 days.
      operationId: insider-sentiment
      parameters:
      - description: 'Symbol of the company: AAPL.'
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: 'From date: 2020-03-15.'
        in: query
        name: from
        required: true
        schema:
          format: date
          type: string
      - description: 'To date: 2020-03-16.'
        in: query
        name: to
        required: true
        schema:
          format: date
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsiderSentiments'
          description: successful operation
      security:
      - api_key: []
      summary: Insider Sentiment
      tags:
      - Default
  /stock/financials:
    get:
      description: <p>Get standardized balance sheet, income statement and cash flow
        for global companies going back 30+ years. Data is sourced from original filings
        most of which made available through <a href="#filings">SEC Filings</a> and
        <a href="#international-filings">International Filings</a> endpoints.</p><p>Set
        <code>preliminary</code> param to true for faster updates for US companies.</p><p><i>Wondering
        why our standardized data is different from Bloomberg, Reuters, Factset, S&P
        or Yahoo Finance ? Check out our <a href="/faq">FAQ page</a> to learn more</i></p>
      operationId: financials
      parameters:
      - description: 'Symbol of the company: AAPL.'
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: Statement can take 1 of these values <code>bs, ic, cf</code>
          for Balance Sheet, Income Statement, Cash Flow respectively.
        in: query
        name: statement
        required: true
        schema:
          type: string
      - description: Frequency can take 1 of these values <code>annual, quarterly,
          ttm, ytd</code>.  TTM (Trailing Twelve Months) option is available for Income
          Statement and Cash Flow. YTD (Year To Date) option is only available for
          Cash Flow.
        in: query
        name: freq
        required: true
        schema:
          type: string
      - description: 'If set to <code>true</code>, it will return Preliminary financial
          statements for the latest period which are usually available within an hour
          of the earnings announcement if finalized data is not available yet. This
          preliminary data is currently available for US companies and reserved for
          Enterprise users only. You will see <code>"preliminary": true</code> in
          the data if that period is using preliminary data.'
        in: query
        name: preliminary
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialStatements'
          description: successful operation
      security:
      - api_key: []
      summary: Financial Statements
      tags:
      - Default
  /stock/financials-reported:
    get:
      description: Get financials as reported. This data is available for bulk download
        on <a href="https://www.kaggle.com/finnhub/reported-financials" target="_blank">Kaggle
        SEC Financials database</a>.
      operationId: financials-reported
      parameters:
      - description: Symbol.
        in: query
        name: symbol
        schema:
          type: string
      - description: CIK.
        in: query
        name: cik
        schema:
          type: string
      - description: Access number of a specific report you want to retrieve financials
          from.
        in: query
        name: accessNumber
        schema:
          type: string
      - description: Frequency. Can be either <code>annual</code> or <code>quarterly</code>.
          Default to <code>annual</code>.
        in: query
        name: freq
        schema:
          type: string
      - description: From date <code>YYYY-MM-DD</code>. Filter for endDate.
        in: query
        name: from
        schema:
          format: date
          type: string
      - description: To date <code>YYYY-MM-DD</code>. Filter for endDate.
        in: query
        name: to
        schema:
          format: date
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialsAsReported'
          description: successful operation
      security:
      - api_key: []
      summary: Financials As Reported
      tags:
      - Default
  /stock/revenue-breakdown:
    get:
      description: <p>Get revenue breakdown as-reporetd by product and geography.
        Users on personal plans can access data for US companies which disclose their
        revenue breakdown in the annual or quarterly reports.</p><p>Global standardized
        revenue breakdown/segments data is available for Enterprise users. <a href="mailto:support@finnhub.io">Contact
        us</a> to inquire about the access for Global standardized data.</p>
      operationId: revenue-breakdown
      parameters:
      - description: Symbol.
        in: query
        name: symbol
        schema:
          type: string
      - description: CIK.
        in: query
        name: cik
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RevenueBreakdown'
          description: successful operation
      security:
      - api_key: []
      summary: Revenue Breakdown
      tags:
      - Default
  /stock/filings:
    get:
      description: List company's filing. Limit to 250 documents at a time. This data
        is available for bulk download on <a href="https://www.kaggle.com/finnhub/sec-filings"
        target="_blank">Kaggle SEC Filings database</a>.
      operationId: filings
      parameters:
      - description: Symbol. Leave <code>symbol</code>,<code>cik</code> and <code>accessNumber</code>
          empty to list latest filings.
        in: query
        name: symbol
        schema:
          type: string
      - description: CIK.
        in: query
        name: cik
        schema:
          type: string
      - description: Access number of a specific report you want to retrieve data
          from.
        in: query
        name: accessNumber
        schema:
          type: string
      - description: Filter by form. You can use this value <code>NT 10-K</code> to
          find non-timely filings for a company.
        in: query
        name: form
        schema:
          type: string
      - description: 'From date: 2023-03-15.'
        in: query
        name: from
        schema:
          format: date
          type: string
      - description: 'To date: 2023-03-16.'
        in: query
        name: to
        schema:
          format: date
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Filing'
                type: array
          description: successful operation
      security:
      - api_key: []
      summary: SEC Filings
      tags:
      - Default
  /stock/filings-sentiment:
    get:
      description: Get sentiment analysis of 10-K and 10-Q filings from SEC. An abnormal
        increase in the number of positive/negative words in filings can signal a
        significant change in the company's stock price in the upcoming 4 quarters.
        We make use of <a href= "https://sraf.nd.edu/textual-analysis/resources/"
        target="_blank">Loughran and McDonald Sentiment Word Lists</a> to calculate
        the sentiment for each filing.
      operationId: filings-sentiment
      parameters:
      - description: Access number of a specific report you want to retrieve data
          from.
        in: query
        name: accessNumber
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SECSentimentAnalysis'
          description: successful operation
      security:
      - api_key: []
      summary: SEC Sentiment Analysis
      tags:
      - Default
  /stock/similarity-index:
    get:
      description: <p>Calculate the textual difference between a company's 10-K /
        10-Q reports and the same type of report in the previous year using Cosine
        Similarity. For example, this endpoint compares 2019's 10-K with 2018's 10-K.
        Companies breaking from its routines in disclosure of financial condition
        and risk analysis section can signal a significant change in the company's
        stock price in the upcoming 4 quarters.</p>
      operationId: similarity-index
      parameters:
      - description: Symbol. Required if cik is empty
        in: query
        name: symbol
        schema:
          type: string
      - description: CIK. Required if symbol is empty
        in: query
        name: cik
        schema:
          type: string
      - description: <code>annual</code> or <code>quarterly</code>. Default to <code>annual</code>
        in: query
        name: freq
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimilarityIndex'
          description: successful operation
      security:
      - api_key: []
      summary: Similarity Index
      tags:
      - Default
  /calendar/ipo:
    get:
      description: Get recent and upcoming IPO.
      operationId: ipo-calendar
      parameters:
      - description: 'From date: 2020-03-15.'
        in: query
        name: from
        required: true
        schema:
          format: date
          type: string
      - description: 'To date: 2020-03-16.'
        in: query
        name: to
        required: true
        schema:
          format: date
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPOCalendar'
          description: successful operation
      security:
      - api_key: []
      summary: IPO Calendar
      tags:
      - Default
  /sector/metrics:
    get:
      description: Get ratios for different sectors and regions/indices.
      operationId: sector-metric
      parameters:
      - description: Region. A list of supported values for this field can be found
          <a href="https://docs.google.com/spreadsheets/d/1afedyv7yWJ-z7pMjaAZK-f6ENY3mI3EBCk95QffpoHw/edit?usp=sharing"
          target="_blank">here</a>.
        in: query
        name: region
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SectorMetric'
          description: successful operation
      security:
      - api_key: []
      summary: Sector Metrics
      tags:
      - Default
  /stock/dividend:
    get:
      description: Get dividends data for common stocks going back 30 years.
      operationId: stock-dividends
      parameters:
      - description: Symbol.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: YYYY-MM-DD.
        in: query
        name: from
        required: true
        schema:
          format: date
          type: string
      - description: YYYY-MM-DD.
        in: query
        name: to
        required: true
        schema:
          format: date
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Dividends'
                type: array
          description: successful operation
      security:
      - api_key: []
      summary: Dividends
      tags:
      - Default
  /stock/recommendation:
    get:
      description: Get latest analyst recommendation trends for a company.
      operationId: recommendation-trends
      parameters:
      - description: 'Symbol of the company: AAPL.'
        in: query
        name: symbol
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/RecommendationTrend'
                type: array
          description: successful operation
      security:
      - api_key: []
      summary: Recommendation Trends
      tags:
      - Default
  /stock/price-target:
    get:
      description: Get latest price target consensus.
      operationId: price-target
      parameters:
      - description: 'Symbol of the company: AAPL.'
        in: query
        name: symbol
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PriceTarget'
          description: successful operation
      security:
      - api_key: []
      summary: Price Target
      tags:
      - Default
  /stock/upgrade-downgrade:
    get:
      description: Get latest stock upgrade and downgrade.
      operationId: upgrade-downgrade
      parameters:
      - description: 'Symbol of the company: AAPL. If left blank, the API will return
          latest stock upgrades/downgrades.'
        in: query
        name: symbol
        schema:
          type: string
      - description: 'From date: 2000-03-15.'
        in: query
        name: from
        schema:
          format: date
          type: string
      - description: 'To date: 2020-03-16.'
        in: query
        name: to
        schema:
          format: date
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/UpgradeDowngrade'
                type: array
          description: successful operation
      security:
      - api_key: []
      summary: Stock Upgrade/Downgrade
      tags:
      - Default
  /stock/revenue-estimate:
    get:
      description: Get company's revenue estimates.
      operationId: company-revenue-estimates
      parameters:
      - description: 'Symbol of the company: AAPL.'
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: 'Can take 1 of the following values: <code>annual, quarterly</code>.
          Default to <code>quarterly</code>'
        in: query
        name: freq
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RevenueEstimates'
          description: successful operation
      security:
      - api_key: []
      summary: Revenue Estimates
      tags:
      - Default
  /stock/ebitda-estimate:
    get:
      description: Get company's ebitda estimates.
      operationId: company-ebitda-estimates
      parameters:
      - description: 'Symbol of the company: AAPL.'
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: 'Can take 1 of the following values: <code>annual, quarterly</code>.
          Default to <code>quarterly</code>'
        in: query
        name: freq
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EbitdaEstimates'
          description: successful operation
      security:
      - api_key: []
      summary: EBITDA Estimates
      tags:
      - Default
  /stock/ebit-estimate:
    get:
      description: Get company's ebit estimates.
      operationId: company-ebit-estimates
      parameters:
      - description: 'Symbol of the company: AAPL.'
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: 'Can take 1 of the following values: <code>annual, quarterly</code>.
          Default to <code>quarterly</code>'
        in: query
        name: freq
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EbitEstimates'
          description: successful operation
      security:
      - api_key: []
      summary: EBIT Estimates
      tags:
      - Default
  /stock/eps-estimate:
    get:
      description: Get company's EPS estimates.
      operationId: company-eps-estimates
      parameters:
      - description: 'Symbol of the company: AAPL.'
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: 'Can take 1 of the following values: <code>annual, quarterly</code>.
          Default to <code>quarterly</code>'
        in: query
        name: freq
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EarningsEstimates'
          description: successful operation
      security:
      - api_key: []
      summary: Earnings Estimates
      tags:
      - Default
  /stock/earnings:
    get:
      description: Get company historical quarterly earnings surprise going back to
        2000.
      operationId: company-earnings
      parameters:
      - description: 'Symbol of the company: AAPL.'
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: Limit number of period returned. Leave blank to get the full
          history.
        in: query
        name: limit
        schema:
          format: int64
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/EarningResult'
                type: array
          description: successful operation
      security:
      - api_key: []
      summary: Earnings Surprises
      tags:
      - Default
  /calendar/earnings:
    get:
      description: Get historical and coming earnings release. EPS and Revenue in
        this endpoint are non-GAAP, which means they are adjusted to exclude some
        one-time or unusual items. This is the same data investors usually react to
        and talked about on the media. Estimates are sourced from both sell-side and
        buy-side analysts.
      operationId: earnings-calendar
      parameters:
      - description: 'From date: 2020-03-15.'
        in: query
        name: from
        schema:
          format: date
          type: string
      - description: 'To date: 2020-03-16.'
        in: query
        name: to
        schema:
          format: date
          type: string
      - description: 'Filter by symbol: AAPL.'
        in: query
        name: symbol
        schema:
          type: string
      - description: Set to <code>true</code> to include international markets. Default
          value is <code>false</code>
        in: query
        name: international
        schema:
          type: boolean
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EarningsCalendar'
          description: successful operation
      security:
      - api_key: []
      summary: Earnings Calendar
      tags:
      - Default
  /quote:
    get:
      description: <p>Get real-time quote data for US stocks. Constant polling is
        not recommended. Use websocket if you need real-time updates.</p><p>Real-time
        stock prices for international markets are supported for Enterprise clients
        via our partner's feed. <a href="mailto:support@finnhub.io">Contact Us</a>
        to learn more.</p>
      operationId: quote
      parameters:
      - description: Symbol
        in: query
        name: symbol
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Quote'
          description: successful operation
      security:
      - api_key: []
      summary: Quote
      tags:
      - Default
  /stock/candle:
    get:
      description: <p>Get candlestick data (OHLCV) for stocks.</p><p>Daily data will
        be adjusted for Splits. Intraday data will remain unadjusted. Only 1 month
        of intraday will be returned at a time. If you need more historical intraday
        data, please use the from and to params iteratively to request more data.</p>
      operationId: stock-candles
      parameters:
      - description: Symbol.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M
          </code>.Some timeframes might not be available depending on the exchange.
        in: query
        name: resolution
        required: true
        schema:
          type: string
      - description: UNIX timestamp. Interval initial value.
        in: query
        name: from
        required: true
        schema:
          format: int64
          type: integer
      - description: UNIX timestamp. Interval end value.
        in: query
        name: to
        required: true
        schema:
          format: int64
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StockCandles'
          description: successful operation
      security:
      - api_key: []
      summary: Stock Candles
      tags:
      - Default
  /stock/tick:
    get:
      description: |-
        <p>Get historical tick data for global exchanges.</p><p>For more historical tick data, you can visit our bulk download page in the Dashboard <a target="_blank" href="/dashboard/download",>here</a> to speed up the download process.</p><table class="table table-hover">
          <thead>
            <tr>
              <th>Exchange</th>
              <th>Segment</th>
              <th>Delay</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <td class="text-blue">US CTA/UTP</th>
              <td>Full SIP</td>
              <td>End-of-day</td>
            </tr>
            <tr>
              <td class="text-blue">TSX</th>
              <td><ul><li>TSX</li><li>TSX Venture</li><li>Index</li></ul></td>
              <td>End-of-day</td>
            </tr>
            <tr>
              <td class="text-blue">LSE</th>
              <td><ul><li>London Stock Exchange (L)</li><li>LSE International (L)</li><li>LSE European (L)</li></ul></td>
              <td>15 minute</td>
            </tr>
            <tr>
              <td class="text-blue">Euronext</th>
              <td><ul> <li>Euronext Paris (PA)</li> <li>Euronext Amsterdam (AS)</li> <li>Euronext Lisbon (LS)</li> <li>Euronext Brussels (BR)</li> <li>Euronext Oslo (OL)</li> <li>Euronext London (LN)</li> <li>Euronext Dublin (IR)</li> <li>Index</li> <li>Warrant</li></ul></td>
              <td>End-of-day</td>
            </tr>
            <tr>
              <td class="text-blue">Deutsche Börse</th>
              <td><ul> <li>Frankfurt (F)</li> <li>Xetra (DE)</li> <li>Duesseldorf (DU)</li> <li>Hamburg (HM)</li> <li>Berlin (BE)</li> <li>Hanover (HA)</li> <li>Stoxx (SX)</li> <li>TradeGate (TG)</li> <li>Zertifikate (SC)</li> <li>Index</li> <li>Warrant</li></ul></td>
              <td>End-of-day</td>
            </tr>
          </tbody>
        </table>
      operationId: stock-tick
      parameters:
      - description: Symbol.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: 'Date: 2020-04-02.'
        in: query
        name: date
        required: true
        schema:
          format: date
          type: string
      - description: 'Limit number of ticks returned. Maximum value: <code>25000</code>'
        in: query
        name: limit
        required: true
        schema:
          format: int64
          type: integer
      - description: Number of ticks to skip. Use this parameter to loop through the
          entire data.
        in: query
        name: skip
        required: true
        schema:
          format: int64
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TickData'
          description: successful operation
      security:
      - api_key: []
      summary: Tick Data
      tags:
      - Default
  /stock/bbo:
    get:
      description: <p>Get historical best bid and offer for US stocks, LSE, TSX, Euronext
        and Deutsche Borse.</p><p>For US market, this endpoint only serves historical
        NBBO from the beginning of 2023. To download more historical data, please
        visit our bulk download page in the Dashboard <a target="_blank" href="/dashboard/download",>here</a>.</p>
      operationId: stock-nbbo
      parameters:
      - description: Symbol.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: 'Date: 2020-04-02.'
        in: query
        name: date
        required: true
        schema:
          format: date
          type: string
      - description: 'Limit number of ticks returned. Maximum value: <code>25000</code>'
        in: query
        name: limit
        required: true
        schema:
          format: int64
          type: integer
      - description: Number of ticks to skip. Use this parameter to loop through the
          entire data.
        in: query
        name: skip
        required: true
        schema:
          format: int64
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HistoricalNBBO'
          description: successful operation
      security:
      - api_key: []
      summary: Historical NBBO
      tags:
      - Default
  /stock/bidask:
    get:
      description: Get last bid/ask data for US stocks.
      operationId: stock-bidask
      parameters:
      - description: Symbol.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LastBid-Ask'
          description: successful operation
      security:
      - api_key: []
      summary: Last Bid-Ask
      tags:
      - Default
  /stock/split:
    get:
      description: Get splits data for stocks.
      operationId: stock-splits
      parameters:
      - description: Symbol.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: YYYY-MM-DD.
        in: query
        name: from
        required: true
        schema:
          format: date
          type: string
      - description: YYYY-MM-DD.
        in: query
        name: to
        required: true
        schema:
          format: date
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Split'
                type: array
          description: successful operation
      security:
      - api_key: []
      summary: Splits
      tags:
      - Default
  /stock/dividend2:
    get:
      description: Get global dividends data.
      operationId: stock-basic-dividends
      parameters:
      - description: Symbol.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dividends2'
          description: successful operation
      security:
      - api_key: []
      summary: Dividends 2 (Basic)
      tags:
      - Default
  /index/constituents:
    get:
      description: Get a list of index's constituents. A list of supported indices
        for this endpoint can be found <a href="/api/v1/index/list?token=" target="_blank">here</a>.
      operationId: indices-constituents
      parameters:
      - description: symbol
        in: query
        name: symbol
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndicesConstituents'
          description: successful operation
      security:
      - api_key: []
      summary: Indices Constituents
      tags:
      - Default
  /index/historical-constituents:
    get:
      description: Get full history of index's constituents including symbols and
        dates of joining and leaving the Index. A list of supported indices for this
        endpoint can be found <a href="/api/v1/index/historical-list?token=" target="_blank">here</a>.
      operationId: indices-historical-constituents
      parameters:
      - description: symbol
        in: query
        name: symbol
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndicesHistoricalConstituents'
          description: successful operation
      security:
      - api_key: []
      summary: Indices Historical Constituents
      tags:
      - Default
  /etf/profile:
    get:
      description: Get ETF profile information. This endpoint has global coverage.
        A list of supported ETFs can be found <a href="/api/v1/etf/list?token=" target="_blank">here</a>.
      operationId: etfs-profile
      parameters:
      - description: ETF symbol.
        in: query
        name: symbol
        schema:
          type: string
      - description: ETF isin.
        in: query
        name: isin
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ETFsProfile'
          description: successful operation
      security:
      - api_key: []
      summary: ETFs Profile
      tags:
      - Default
  /etf/holdings:
    get:
      description: Get full ETF holdings/constituents. This endpoint has global coverage.
        Widget only shows top 10 holdings. A list of supported ETFs can be found <a
        href="/api/v1/etf/list?token=" target="_blank">here</a>.
      operationId: etfs-holdings
      parameters:
      - description: ETF symbol.
        in: query
        name: symbol
        schema:
          type: string
      - description: ETF isin.
        in: query
        name: isin
        schema:
          type: string
      - description: Skip the first n results. You can use this parameter to query
          historical constituents data. The latest result is returned if skip=0 or
          not set.
        in: query
        name: skip
        schema:
          format: int64
          type: integer
      - description: Query holdings by date. You can use either this param or <code>skip</code>
          param, not both.
        in: query
        name: date
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ETFsHoldings'
          description: successful operation
      security:
      - api_key: []
      summary: ETFs Holdings
      tags:
      - Default
  /etf/sector:
    get:
      description: Get ETF sector exposure data.
      operationId: etfs-sector-exposure
      parameters:
      - description: ETF symbol.
        in: query
        name: symbol
        schema:
          type: string
      - description: ETF isin.
        in: query
        name: isin
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ETFsSectorExposure'
          description: successful operation
      security:
      - api_key: []
      summary: ETFs Sector Exposure
      tags:
      - Default
  /etf/country:
    get:
      description: Get ETF country exposure data.
      operationId: etfs-country-exposure
      parameters:
      - description: ETF symbol.
        in: query
        name: symbol
        schema:
          type: string
      - description: ETF isin.
        in: query
        name: isin
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ETFsCountryExposure'
          description: successful operation
      security:
      - api_key: []
      summary: ETFs Country Exposure
      tags:
      - Default
  /mutual-fund/profile:
    get:
      description: Get mutual funds profile information. This endpoint covers both
        US and global mutual funds. For international funds, you must query the data
        using ISIN. A list of supported funds can be found <a href="/api/v1/mutual-fund/list?token="
        target="_blank">here</a>.
      operationId: mutual-fund-profile
      parameters:
      - description: Fund's symbol.
        in: query
        name: symbol
        schema:
          type: string
      - description: Fund's isin.
        in: query
        name: isin
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MutualFundProfile'
          description: successful operation
      security:
      - api_key: []
      summary: Mutual Funds Profile
      tags:
      - Default
  /mutual-fund/holdings:
    get:
      description: Get full Mutual Funds holdings/constituents. This endpoint covers
        both US and global mutual funds. For international funds, you must query the
        data using ISIN. A list of supported funds can be found <a href="/api/v1/mutual-fund/list?token="
        target="_blank">here</a>.
      operationId: mutual-fund-holdings
      parameters:
      - description: Fund's symbol.
        in: query
        name: symbol
        schema:
          type: string
      - description: Fund's isin.
        in: query
        name: isin
        schema:
          type: string
      - description: Skip the first n results. You can use this parameter to query
          historical constituents data. The latest result is returned if skip=0 or
          not set.
        in: query
        name: skip
        schema:
          format: int64
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MutualFundHoldings'
          description: successful operation
      security:
      - api_key: []
      summary: Mutual Funds Holdings
      tags:
      - Default
  /mutual-fund/sector:
    get:
      description: Get Mutual Funds sector exposure data.
      operationId: mutual-fund-sector-exposure
      parameters:
      - description: Mutual Fund symbol.
        in: query
        name: symbol
        schema:
          type: string
      - description: Fund's isin.
        in: query
        name: isin
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MutualFundSectorExposure'
          description: successful operation
      security:
      - api_key: []
      summary: Mutual Funds Sector Exposure
      tags:
      - Default
  /mutual-fund/country:
    get:
      description: Get Mutual Funds country exposure data.
      operationId: mutual-fund-country-exposure
      parameters:
      - description: Symbol.
        in: query
        name: symbol
        schema:
          type: string
      - description: Fund's isin.
        in: query
        name: isin
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MutualFundCountryExposure'
          description: successful operation
      security:
      - api_key: []
      summary: Mutual Funds Country Exposure
      tags:
      - Default
  /mutual-fund/eet:
    get:
      description: Get EET data for EU funds. For PAIs data, please see the EET PAI
        endpoint.
      operationId: mutual-fund-eet
      parameters:
      - description: ISIN.
        in: query
        name: isin
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MutualFundEet'
          description: successful operation
      security:
      - api_key: []
      summary: Mutual Funds EET
      tags:
      - Default
  /mutual-fund/eet-pai:
    get:
      description: Get EET PAI data for EU funds.
      operationId: mutual-fund-eet-pai
      parameters:
      - description: ISIN.
        in: query
        name: isin
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MutualFundEetPai'
          description: successful operation
      security:
      - api_key: []
      summary: Mutual Funds EET PAI
      tags:
      - Default
  /forex/exchange:
    get:
      description: List supported forex exchanges
      operationId: forex-exchanges
      responses:
        "200":
          content:
            application/json:
              schema:
                items:
                  type: string
                type: array
          description: successful operation
      security:
      - api_key: []
      summary: Forex Exchanges
      tags:
      - Default
  /forex/symbol:
    get:
      description: List supported forex symbols.
      operationId: forex-symbols
      parameters:
      - description: Exchange you want to get the list of symbols from.
        in: query
        name: exchange
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ForexSymbol'
                type: array
          description: successful operation
      security:
      - api_key: []
      summary: Forex Symbol
      tags:
      - Default
  /forex/candle:
    get:
      description: Get candlestick data for forex symbols.
      operationId: forex-candles
      parameters:
      - description: Use symbol returned in <code>/forex/symbol</code> endpoint for
          this field.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M
          </code>.Some timeframes might not be available depending on the exchange.
        in: query
        name: resolution
        required: true
        schema:
          type: string
      - description: UNIX timestamp. Interval initial value.
        in: query
        name: from
        required: true
        schema:
          format: int64
          type: integer
      - description: UNIX timestamp. Interval end value.
        in: query
        name: to
        required: true
        schema:
          format: int64
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForexCandles'
          description: successful operation
      security:
      - api_key: []
      summary: Forex Candles
      tags:
      - Default
  /forex/rates:
    get:
      description: Get rates for all forex pairs. Ideal for currency conversion
      operationId: forex-rates
      parameters:
      - description: Base currency. Default to EUR.
        in: query
        name: base
        schema:
          type: string
      - description: Date. Leave blank to get the latest data.
        in: query
        name: date
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forexrates'
          description: successful operation
      security:
      - api_key: []
      summary: Forex rates
      tags:
      - Default
  /crypto/exchange:
    get:
      description: List supported crypto exchanges
      operationId: crypto-exchanges
      responses:
        "200":
          content:
            application/json:
              schema:
                items:
                  type: string
                type: array
          description: successful operation
      security:
      - api_key: []
      summary: Crypto Exchanges
      tags:
      - Default
  /crypto/symbol:
    get:
      description: List supported crypto symbols by exchange
      operationId: crypto-symbols
      parameters:
      - description: Exchange you want to get the list of symbols from.
        in: query
        name: exchange
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/CryptoSymbol'
                type: array
          description: successful operation
      security:
      - api_key: []
      summary: Crypto Symbol
      tags:
      - Default
  /crypto/profile:
    get:
      description: Get crypto's profile.
      operationId: crypto-profile
      parameters:
      - description: Crypto symbol such as BTC or ETH.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CryptoProfile'
          description: successful operation
      security:
      - api_key: []
      summary: Crypto Profile
      tags:
      - Default
  /crypto/candle:
    get:
      description: Get candlestick data for crypto symbols.
      operationId: crypto-candles
      parameters:
      - description: Use symbol returned in <code>/crypto/symbol</code> endpoint for
          this field.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M
          </code>.Some timeframes might not be available depending on the exchange.
        in: query
        name: resolution
        required: true
        schema:
          type: string
      - description: UNIX timestamp. Interval initial value.
        in: query
        name: from
        required: true
        schema:
          format: int64
          type: integer
      - description: UNIX timestamp. Interval end value.
        in: query
        name: to
        required: true
        schema:
          format: int64
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CryptoCandles'
          description: successful operation
      security:
      - api_key: []
      summary: Crypto Candles
      tags:
      - Default
  /scan/pattern:
    get:
      description: Run pattern recognition algorithm on a symbol. Support double top/bottom,
        triple top/bottom, head and shoulders, triangle, wedge, channel, flag, and
        candlestick patterns.
      operationId: pattern-recognition
      parameters:
      - description: Symbol
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M
          </code>.Some timeframes might not be available depending on the exchange.
        in: query
        name: resolution
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatternRecognition'
          description: successful operation
      security:
      - api_key: []
      summary: Pattern Recognition
      tags:
      - Default
  /scan/support-resistance:
    get:
      description: Get support and resistance levels for a symbol.
      operationId: support-resistance
      parameters:
      - description: Symbol
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M
          </code>.Some timeframes might not be available depending on the exchange.
        in: query
        name: resolution
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupportResistance'
          description: successful operation
      security:
      - api_key: []
      summary: Support/Resistance
      tags:
      - Default
  /scan/technical-indicator:
    get:
      description: Get aggregate signal of multiple technical indicators such as MACD,
        RSI, Moving Average v.v. A full list of indicators can be found <a href="https://docs.google.com/spreadsheets/d/1MWuy0WuT2yVlxr1KbPdggVygMZtJfunDnhe-C0GEXYM/edit?usp=sharing"
        target="_blank">here</a>.
      operationId: aggregate-indicator
      parameters:
      - description: symbol
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M
          </code>.Some timeframes might not be available depending on the exchange.
        in: query
        name: resolution
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AggregateIndicators'
          description: successful operation
      security:
      - api_key: []
      summary: Aggregate Indicators
      tags:
      - Default
  /indicator:
    get:
      description: Return technical indicator with price data. List of supported indicators
        can be found <a href="https://docs.google.com/spreadsheets/d/1ylUvKHVYN2E87WdwIza8ROaCpd48ggEl1k5i5SgA29k/edit?usp=sharing"
        target="_blank">here</a>.
      operationId: technical-indicator
      parameters:
      - description: symbol
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M
          </code>.Some timeframes might not be available depending on the exchange.
        in: query
        name: resolution
        required: true
        schema:
          type: string
      - description: UNIX timestamp. Interval initial value.
        in: query
        name: from
        required: true
        schema:
          format: int64
          type: integer
      - description: UNIX timestamp. Interval end value.
        in: query
        name: to
        required: true
        schema:
          format: int64
          type: integer
      - description: Indicator name. Full list can be found <a href="https://docs.google.com/spreadsheets/d/1ylUvKHVYN2E87WdwIza8ROaCpd48ggEl1k5i5SgA29k/edit?usp=sharing"
          target="_blank">here</a>.
        in: query
        name: indicator
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IndicatorFields'
        description: Check out <a href="https://docs.google.com/spreadsheets/d/1ylUvKHVYN2E87WdwIza8ROaCpd48ggEl1k5i5SgA29k/edit?usp=sharing"
          target="_blank">this page</a> to see which indicators and params are supported.
        required: false
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TechnicalIndicator'
          description: successful operation
      security:
      - api_key: []
      summary: Technical Indicators
      tags:
      - Default
      x-codegen-request-body-name: indicator_fields
  /stock/transcripts/list:
    get:
      description: List earnings call transcripts' metadata. This endpoint is available
        for US, UK, European, Australian and Canadian companies.
      operationId: transcripts-list
      parameters:
      - description: 'Company symbol: AAPL. Leave empty to list the latest transcripts'
        in: query
        name: symbol
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EarningsCallTranscriptsList'
          description: successful operation
      security:
      - api_key: []
      summary: Earnings Call Transcripts List
      tags:
      - Default
  /stock/transcripts:
    get:
      description: <p>Get earnings call transcripts, audio and participants' list.
        Data is available for US, UK, European, Australian and Canadian companies.<p>15+
        years of data is available with 220,000+ audio which add up to 7TB in size.</p>
      operationId: transcripts
      parameters:
      - description: Transcript's id obtained with <a href="#transcripts-list">Transcripts
          List endpoint</a>.
        in: query
        name: id
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EarningsCallTranscripts'
          description: successful operation
      security:
      - api_key: []
      summary: Earnings Call Transcripts
      tags:
      - Default
  /stock/earnings-call-live:
    get:
      description: <p>Stream live earnings calls with data provided in the calendar.
        The data will be available in m3u8 format. mp3 files will be available once
        the calls finish in the <code>recording</code> field.</p>
      operationId: earnings-call-live
      parameters:
      - description: From date <code>YYYY-MM-DD</code>.
        in: query
        name: from
        schema:
          format: date
          type: string
      - description: To date <code>YYYY-MM-DD</code>.
        in: query
        name: to
        schema:
          format: date
          type: string
      - description: 'Filter by symbol: AAPL.'
        in: query
        name: symbol
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EarningsCallLive'
          description: successful operation
      security:
      - api_key: []
      summary: Earnings Call Audio Live
      tags:
      - Default
  /stock/presentation:
    get:
      description: <p>Get presentations/slides data in PDF format that are usually
        used during earnings calls.</p>
      operationId: stock-presentation
      parameters:
      - description: Company symbol.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StockPresentation'
          description: successful operation
      security:
      - api_key: []
      summary: Company Presentation
      tags:
      - Default
  /stock/social-sentiment:
    get:
      description: <p>Get social sentiment for stocks on Reddit and Twitter.</p>
      operationId: social-sentiment
      parameters:
      - description: Company symbol.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: From date <code>YYYY-MM-DD</code>.
        in: query
        name: from
        schema:
          format: date
          type: string
      - description: To date <code>YYYY-MM-DD</code>.
        in: query
        name: to
        schema:
          format: date
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SocialSentiment'
          description: successful operation
      security:
      - api_key: []
      summary: Social Sentiment
      tags:
      - Default
  /stock/investment-theme:
    get:
      description: <p>Thematic investing involves creating a portfolio (or portion
        of a portfolio) by gathering together a collection of companies involved in
        certain areas that you predict will generate above-market returns over the
        long term. Themes can be based on a concept such as ageing populations or
        a sub-sector such as robotics, and drones. Thematic investing focuses on predicted
        long-term trends rather than specific companies or sectors, enabling investors
        to access structural, one-off shifts that can change an entire industry.</p><p>This
        endpoint will help you get portfolios of different investment themes that
        are changing our life and are the way of the future.</p><p>A full list of
        themes supported can be found <a target="_blank" href="https://docs.google.com/spreadsheets/d/1ULj9xDh4iPoQj279M084adZ2_S852ttRthKKJ7madYc/edit?usp=sharing">here</a>.
        The theme coverage and portfolios are updated bi-weekly by our analysts. Our
        approach excludes penny, super-small cap and illiquid stocks.</p>
      operationId: investment-themes
      parameters:
      - description: Investment theme. A full list of themes supported can be found
          <a target="_blank" href="https://docs.google.com/spreadsheets/d/1ULj9xDh4iPoQj279M084adZ2_S852ttRthKKJ7madYc/edit?usp=sharing">here</a>.
        in: query
        name: theme
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvestmentThemes'
          description: successful operation
      security:
      - api_key: []
      summary: Investment Themes (Thematic Investing)
      tags:
      - Default
  /stock/supply-chain:
    get:
      description: <p>This endpoint provides an overall map of public companies' key
        customers and suppliers. The data offers a deeper look into a company's supply
        chain and how products are created. The data will help investors manage risk,
        limit exposure or generate alpha-generating ideas and trading insights.</p>
      operationId: supply-chain-relationships
      parameters:
      - description: Symbol.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupplyChainRelationships'
          description: successful operation
      security:
      - api_key: []
      summary: Supply Chain Relationships
      tags:
      - Default
  /stock/esg:
    get:
      description: <p>This endpoint provides the latest ESG scores and important indicators
        for 7000+ global companies. The data is collected through company's public
        ESG disclosure and public sources.</p><p>Our ESG scoring models takes into
        account more than 150 different inputs to calculate the level of ESG risks
        and how well a company is managing them. A higher score means lower ESG risk
        or better ESG management. ESG scores are in the the range of 0-100. Some key
        indicators might contain letter-grade score from C- to A+ with C- is the lowest
        score and A+ is the highest score.</p>
      operationId: company-esg-score
      parameters:
      - description: Symbol.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyESG'
          description: successful operation
      security:
      - api_key: []
      summary: Company ESG Scores
      tags:
      - Default
  /stock/historical-esg:
    get:
      description: <p>This endpoint provides historical ESG scores and important indicators
        for 7000+ global companies. The data is collected through company's public
        ESG disclosure and public sources.</p><p>Our ESG scoring models takes into
        account more than 150 different inputs to calculate the level of ESG risks
        and how well a company is managing them. A higher score means lower ESG risk
        or better ESG management. ESG scores are in the the range of 0-100. Some key
        indicators might contain letter-grade score from C- to A+ with C- is the lowest
        score and A+ is the highest score.</p>
      operationId: company-historical-esg-score
      parameters:
      - description: Symbol.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HistoricalCompanyESG'
          description: successful operation
      security:
      - api_key: []
      summary: Historical ESG Scores
      tags:
      - Default
  /stock/earnings-quality-score:
    get:
      description: '<p>This endpoint provides Earnings Quality Score for global companies.</p><p>
        Earnings quality refers to the extent to which current earnings predict future
        earnings. "High-quality" earnings are expected to persist, while "low-quality"
        earnings do not. A higher score means a higher earnings quality</p><p>Finnhub
        uses a proprietary model which takes into consideration 4 criteria:</p> <ul
        style="list-style-type: unset; margin-left: 30px;"><li>Profitability</li><li>Growth</li><li>Cash
        Generation & Capital Allocation</li><li>Leverage</li></ul><br/><p>We then
        compare the metrics of each company in each category against its peers in
        the same industry to gauge how quality its earnings is.</p>'
      operationId: company-earnings-quality-score
      parameters:
      - description: Symbol.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: Frequency. Currently support <code>annual</code> and <code>quarterly</code>
        in: query
        name: freq
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyEarningsQualityScore'
          description: successful operation
      security:
      - api_key: []
      summary: Company Earnings Quality Score
      tags:
      - Default
  /covid19/us:
    get:
      description: Get real-time updates on the number of COVID-19 (Corona virus)
        cases in the US with a state-by-state breakdown. Data is sourced from CDC
        and reputable sources. You can also access this API <a href="https://rapidapi.com/Finnhub/api/finnhub-real-time-covid-19"
        target="_blank" rel="nofollow">here</a>
      operationId: covid-19
      responses:
        "200":
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/CovidInfo'
                type: array
          description: successful operation
      security:
      - api_key: []
      summary: COVID-19
      tags:
      - Default
  /fda-advisory-committee-calendar:
    get:
      description: FDA's advisory committees are established to provide functions
        which support the agency's mission of protecting and promoting the public
        health, while meeting the requirements set forth in the Federal Advisory Committee
        Act. Committees are either mandated by statute or established at the discretion
        of the Department of Health and Human Services. Each committee is subject
        to renewal at two-year intervals unless the committee charter states otherwise.
      operationId: fda-committee-meeting-calendar
      responses:
        "200":
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/FDAComitteeMeeting'
                type: array
          description: successful operation
      security:
      - api_key: []
      summary: FDA Committee Meeting Calendar
      tags:
      - Default
  /stock/uspto-patent:
    get:
      description: List USPTO patents for companies. Limit to 250 records per API
        call.
      operationId: stock-uspto-patent
      parameters:
      - description: Symbol.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: From date <code>YYYY-MM-DD</code>.
        in: query
        name: from
        required: true
        schema:
          format: date
          type: string
      - description: To date <code>YYYY-MM-DD</code>.
        in: query
        name: to
        required: true
        schema:
          format: date
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsptoPatentResult'
          description: successful operation
      security:
      - api_key: []
      summary: USPTO Patents
      tags:
      - Default
  /stock/visa-application:
    get:
      description: Get a list of H1-B and Permanent visa applications for companies
        from the DOL. The data is updated quarterly.
      operationId: stock-visa-application
      parameters:
      - description: Symbol.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: From date <code>YYYY-MM-DD</code>. Filter on the <code>beginDate</code>
          column.
        in: query
        name: from
        required: true
        schema:
          format: date
          type: string
      - description: To date <code>YYYY-MM-DD</code>. Filter on the <code>beginDate</code>
          column.
        in: query
        name: to
        required: true
        schema:
          format: date
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VisaApplicationResult'
          description: successful operation
      security:
      - api_key: []
      summary: H1-B Visa Application
      tags:
      - Default
  /stock/lobbying:
    get:
      description: Get a list of reported lobbying activities in the Senate and the
        House.
      operationId: stock-lobbying
      parameters:
      - description: Symbol.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: From date <code>YYYY-MM-DD</code>.
        in: query
        name: from
        required: true
        schema:
          format: date
          type: string
      - description: To date <code>YYYY-MM-DD</code>.
        in: query
        name: to
        required: true
        schema:
          format: date
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LobbyingResult'
          description: successful operation
      security:
      - api_key: []
      summary: Senate Lobbying
      tags:
      - Default
  /stock/usa-spending:
    get:
      description: Get a list of government's spending activities from USASpending
        dataset for public companies. This dataset can help you identify companies
        that win big government contracts which is extremely important for industries
        such as Defense, Aerospace, and Education.
      operationId: stock-usa-spending
      parameters:
      - description: Symbol.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: From date <code>YYYY-MM-DD</code>. Filter for <code>actionDate</code>
        in: query
        name: from
        required: true
        schema:
          format: date
          type: string
      - description: To date <code>YYYY-MM-DD</code>. Filter for <code>actionDate</code>
        in: query
        name: to
        required: true
        schema:
          format: date
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsaSpendingResult'
          description: successful operation
      security:
      - api_key: []
      summary: USA Spending
      tags:
      - Default
  /stock/congressional-trading:
    get:
      description: Get stock trades data disclosed by members of congress.
      operationId: congressional-trading
      parameters:
      - description: 'Symbol of the company: AAPL.'
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: From date <code>YYYY-MM-DD</code>.
        in: query
        name: from
        required: true
        schema:
          format: date
          type: string
      - description: To date <code>YYYY-MM-DD</code>.
        in: query
        name: to
        required: true
        schema:
          format: date
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CongressionalTrading'
          description: successful operation
      security:
      - api_key: []
      summary: Congressional Trading
      tags:
      - Default
  /bond/profile:
    get:
      description: Get general information of a bond. You can query by FIGI, ISIN
        or CUSIP. A list of supported bonds can be found <a href="/api/v1/bond/list?token="
        target="_blank">here</a>.
      operationId: bond-profile
      parameters:
      - description: ISIN
        in: query
        name: isin
        schema:
          type: string
      - description: CUSIP
        in: query
        name: cusip
        schema:
          type: string
      - description: FIGI
        in: query
        name: figi
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BondProfile'
          description: successful operation
      security:
      - api_key: []
      summary: Bond Profile
      tags:
      - Default
  /bond/price:
    get:
      description: |-
        <p>Get bond's price data. The following datasets are supported:</p><table class="table table-hover">
          <thead>
            <tr>
              <th>Exchange</th>
              <th>Segment</th>
              <th>Delay</th>
            </tr>
          </thead>
          <tbody>
          <tr>
              <td class="text-blue">US Government Bonds</th>
              <td>Government Bonds</td>
              <td>End-of-day</td>
            </tr>
            <tr>
              <td class="text-blue">FINRA Trace</th>
              <td>BTDS: US Corporate Bonds</td>
              <td>Delayed 4h</td>
            </tr>
            <tr>
              <td class="text-blue">FINRA Trace</th>
              <td>144A Bonds</td>
              <td>Delayed 4h</td>
            </tr>
          </tbody>
        </table>
      operationId: bond-price
      parameters:
      - description: ISIN.
        in: query
        name: isin
        required: true
        schema:
          type: string
      - description: UNIX timestamp. Interval initial value.
        in: query
        name: from
        required: true
        schema:
          format: int64
          type: integer
      - description: UNIX timestamp. Interval end value.
        in: query
        name: to
        required: true
        schema:
          format: int64
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BondCandles'
          description: successful operation
      security:
      - api_key: []
      summary: Bond price data
      tags:
      - Default
  /bond/tick:
    get:
      description: |-
        <p>Get trade-level data for bonds. The following datasets are supported:</p><table class="table table-hover">
          <thead>
            <tr>
              <th>Exchange</th>
              <th>Segment</th>
              <th>Delay</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <td class="text-blue">FINRA Trace</th>
              <td>BTDS: US Corporate Bonds</td>
              <td>Delayed 4h</td>
            </tr>
            <tr>
              <td class="text-blue">FINRA Trace</th>
              <td>144A Bonds</td>
              <td>Delayed 4h</td>
            </tr>
          </tbody>
        </table>
      operationId: bond-tick
      parameters:
      - description: ISIN.
        in: query
        name: isin
        required: true
        schema:
          type: string
      - description: 'Date: 2020-04-02.'
        in: query
        name: date
        required: true
        schema:
          format: date
          type: string
      - description: 'Limit number of ticks returned. Maximum value: <code>25000</code>'
        in: query
        name: limit
        required: true
        schema:
          format: int64
          type: integer
      - description: Number of ticks to skip. Use this parameter to loop through the
          entire data.
        in: query
        name: skip
        required: true
        schema:
          format: int64
          type: integer
      - description: 'Currently support the following values: <code>trace</code>.'
        in: query
        name: exchange
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BondTickData'
          description: successful operation
      security:
      - api_key: []
      summary: Bond Tick Data
      tags:
      - Default
  /bond/yield-curve:
    get:
      description: Get yield curve data for Treasury bonds.
      operationId: bond-yield-curve
      parameters:
      - description: Bond's code. You can find the list of supported code <a href="https://docs.google.com/spreadsheets/d/1iA-lM0Kht7lsQZ7Uu_s6r2i1BbQNUNO9eGkO5-zglHg/edit?usp=sharing"
          target="_blank" rel="noopener">here</a>.
        in: query
        name: code
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BondYieldCurve'
          description: successful operation
      security:
      - api_key: []
      summary: Bond Yield Curve
      tags:
      - Default
  /bank-branch:
    get:
      description: Retrieve list of US bank branches information for a given symbol.
      operationId: bank-branch
      parameters:
      - description: Symbol.
        in: query
        name: symbol
        required: true
        schema: {}
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankBranchRes'
          description: successful operation
      security:
      - api_key: []
      summary: Bank Branch List
      tags:
      - Default
  /airline/price-index:
    get:
      description: <p>The Flight Ticket Price Index API provides comprehensive data
        on airline ticket prices, including the average daily ticket price and its
        percentage change (price index). This data, collected weekly and projected
        two weeks ahead, aggregates daily prices and indexes from the 50 busiest and
        largest airports across the USA. The dataset includes detailed information
        on airlines, dates, and average ticket prices, offering valuable insights
        for market analysis and pricing strategies.</p><p>The price index is calculated
        as percentage change of average daily ticket price from the previous weekly
        reading. Raw ticket prices data is available for Enterprise users. <a href="mailto:support@finnhub.io">Contact
        us</a> to inquire about the raw price data.</p>
      operationId: airline-price-index
      parameters:
      - description: 'Filter data by airline. Accepted values: <code>united</code>,<code>delta</code>,<code>american_airlines</code>,<code>southwest</code>,<code>southern_airways_express</code>,<code>alaska_airlines</code>,<code>frontier_airlines</code>,<code>jetblue_airways</code>,<code>spirit_airlines</code>,<code>sun_country_airlines</code>,<code>breeze_airways</code>,<code>hawaiian_airlines</code>'
        in: query
        name: airline
        required: true
        schema:
          type: string
      - description: From date <code>YYYY-MM-DD</code>.
        in: query
        name: from
        required: true
        schema:
          format: date
          type: string
      - description: To date <code>YYYY-MM-DD</code>.
        in: query
        name: to
        required: true
        schema:
          format: date
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AirlinePriceIndexData'
          description: successful operation
      security:
      - api_key: []
      summary: Airline Price Index
      tags:
      - Default
  /country:
    get:
      description: List all countries and metadata.
      operationId: country
      responses:
        "200":
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/CountryMetadata'
                type: array
          description: successful operation
      security:
      - api_key: []
      summary: Country Metadata
      tags:
      - Default
  /calendar/economic:
    get:
      description: <p>Get recent and upcoming economic releases.</p><p>Historical
        events and surprises are available for Enterprise clients.</p>
      operationId: economic-calendar
      parameters:
      - description: From date <code>YYYY-MM-DD</code>.
        in: query
        name: from
        schema:
          format: date
          type: string
      - description: To date <code>YYYY-MM-DD</code>.
        in: query
        name: to
        schema:
          format: date
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EconomicCalendar'
          description: successful operation
      security:
      - api_key: []
      summary: Economic Calendar
      tags:
      - Default
  /economic/code:
    get:
      description: List codes of supported economic data.
      operationId: economic-code
      responses:
        "200":
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/EconomicCode'
                type: array
          description: successful operation
      security:
      - api_key: []
      summary: Economic Code
      tags:
      - Default
  /economic:
    get:
      description: Get economic data.
      operationId: economic-data
      parameters:
      - description: Economic code.
        in: query
        name: code
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EconomicData'
          description: successful operation
      security:
      - api_key: []
      summary: Economic Data
      tags:
      - Default
  /stock/international-filings:
    get:
      description: List filings for international companies. Limit to 500 documents
        at a time. These are the documents we use to source our fundamental data.
        Enterprise clients who need access to the full filings for global markets
        should contact us for the access.
      operationId: international-filings
      parameters:
      - description: Symbol. Leave empty to list latest filings.
        in: query
        name: symbol
        schema:
          type: string
      - description: Filter by country using country's 2-letter code.
        in: query
        name: country
        schema:
          type: string
      - description: 'From date: 2023-01-15.'
        in: query
        name: from
        schema:
          format: date
          type: string
      - description: 'To date: 2023-12-16.'
        in: query
        name: to
        schema:
          format: date
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/InternationalFiling'
                type: array
          description: successful operation
      security:
      - api_key: []
      summary: International Filings
      tags:
      - Default
  /stock/revenue-breakdown2:
    get:
      description: <p>Get standardized revenue breakdown and KPIs data for 30,000+
        global companies.</p>
      operationId: revenue-breakdown2
      parameters:
      - description: Symbol.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RevenueBreakdown2'
          description: successful operation
      security:
      - api_key: []
      summary: Revenue Breakdown & KPI
      tags:
      - Default
  /stock/newsroom:
    get:
      description: <p>Get latest articles posted directly on the companies' newsroom
        and investor relations page. Newsroom API along with the Press Releases API
        provide a comprehensive text-based dataset directly from the company. We currently
        cover 1,500 US Companies with this dataset.</p>
      operationId: newsroom
      parameters:
      - description: Company symbol.
        in: query
        name: symbol
        required: true
        schema:
          type: string
      - description: 'From time: 2025-01-01.'
        in: query
        name: from
        schema:
          format: date
          type: string
      - description: 'To time: 2026-01-05.'
        in: query
        name: to
        schema:
          format: date
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Newsroom'
          description: successful operation
      security:
      - api_key: []
      summary: Newsroom
      tags:
      - Default
  /ai-chat:
    post:
      description: <p>Chat with our AI copilot powered by Neyman AI trained on the
        extensive Finnhub's global data. You can ask it any finance-related questions
        just like with other LLM models and receive results in texts and widgets.</p>
      operationId: ai-chat
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AIChatBody'
        description: Search body
        required: false
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AIChatResponse'
          description: successful operation
      security:
      - api_key: []
      summary: AI Copilot
      tags:
      - Default
      x-codegen-request-body-name: search
components:
  schemas:
    SearchBody:
      properties:
        query:
          description: Search query
          type: string
        isins:
          description: 'List of isin to search, comma separated (Max: 50).'
          type: string
        cusips:
          description: 'List of cusip to search, comma separated (Max: 50).'
          type: string
        ciks:
          description: 'List of SEC Center Index Key to search, comma separated (Max:
            50).'
          type: string
        sedarIds:
          description: 'List of SEDAR issuer number to search, comma separated (Max:
            50).'
          type: string
        chIds:
          description: 'List of Companies House number to search, comma separated
            (Max: 50).'
          type: string
        symbols:
          description: 'List of symbols to search, comma separated (Max: 50).'
          type: string
        sedols:
          description: 'List of sedols to search, comma separated (Max: 50).'
          type: string
        sources:
          description: 'List of sources to search, comma separated (Max: 50). Look
            at <code>/filter</code> endpoint to see all available values.'
          type: string
        forms:
          description: 'List of forms to search, comma separated (Max: 50). Look at
            <code>/filter</code> endpoint to see all available values.'
          type: string
        gics:
          description: 'List of gics to search, comma separated (Max: 50). Look at
            <code>/filter</code> endpoint to see all available values.'
          type: string
        naics:
          description: 'List of sources to search, comma separated (Max: 50). Look
            at <code>/filter</code> endpoint to see all available values.'
          type: string
        exhibits:
          description: 'List of exhibits to search, comma separated (Max: 50). Look
            at <code>/filter</code> endpoint to see all available values.'
          type: string
        exchanges:
          description: 'List of exchanges to search, comma separated (Max: 50). Look
            at <code>/filter</code> endpoint to see all available values.'
          type: string
        countries:
          description: 'List of sources to search, comma separated (Max: 50). Look
            at <code>/filter</code> endpoint to see all available values.'
          type: string
        acts:
          description: List of SEC's exchanges act to search, comma separated. Look
            at <code>/filter</code> endpoint to see all available values.
          type: string
        caps:
          description: List of market capitalization to search, comma separated. Look
            at <code>/filter</code> endpoint to see all available values.
          type: string
        fromDate:
          description: 'Search from date in format: YYYY-MM-DD, default from the last
            2 years'
          type: string
        toDate:
          description: 'Search to date in format: YYYY-MM-DD, default to today'
          type: string
        page:
          description: Use for pagination, default to page 1
          type: string
        sort:
          description: 'Sort result by, default: sortMostRecent. Look at <code>/filter</code>
            endpoint to see all available values.'
          type: string
        highlighted:
          description: Enable highlight in returned filings. If enabled, only return
            10 results each time
          type: boolean
      required:
      - query
      type: object
    AIChatBody:
      example:
        stream: true
        messages:
        - role: role
          content: content
        - role: role
          content: content
      properties:
        messages:
          description: Messages
          items:
            $ref: '#/components/schemas/AIChatMessage'
          type: array
        stream:
          description: Stream responses
          type: boolean
      required:
      - messages
      type: object
    AIChatMessage:
      example:
        role: role
        content: content
      properties:
        role:
          description: Role system/user
          type: string
        content:
          description: Content
          type: string
      type: object
    AIChatResponse:
      example:
        chatId: chatId
        relatedQueries:
        - '{}'
        - '{}'
        sources:
        - '{}'
        - '{}'
        widgets:
        - '{}'
        - '{}'
        tickers:
        - '{}'
        - '{}'
        content: content
        querySummary: querySummary
      properties:
        chatId:
          description: Chat ID.
          type: string
        content:
          description: Response text.
          type: string
        querySummary:
          description: Query summary
          type: string
        relatedQueries:
          description: Related queries.
          items:
            properties: {}
            type: object
          type: array
        tickers:
          description: List of tickers mentioned.
          items:
            properties: {}
            type: object
          type: array
        sources:
          description: Sources.
          items:
            properties: {}
            type: object
          type: array
        widgets:
          description: Widgets.
          items:
            properties: {}
            type: object
          type: array
      type: object
    InFilingSearchBody:
      properties:
        query:
          description: Search query
          type: string
        filingId:
          description: Filing Id to search
          type: string
      required:
      - filingId
      - query
      type: object
    SearchResponse:
      properties:
        count:
          description: Total filing matched your search criteria.
          type: integer
        took:
          description: Time took to execute your search query on our server, value
            in ms.
          type: integer
        page:
          description: Current search page
          type: integer
        filings:
          description: Filing match your search criteria.
          items:
            $ref: '#/components/schemas/FilingResponse'
          type: array
      type: object
    FilingResponse:
      properties:
        filingId:
          description: Filing Id in Alpharesearch platform
          type: string
        title:
          description: Filing title
          type: string
        filerId:
          description: Id of the entity submitted the filing
          type: string
        symbol:
          description: List of symbol associate with this filing
          type: object
        name:
          description: Filer name
          type: string
        acceptanceDate:
          description: Date the filing is submitted.
          type: string
        filedDate:
          description: Date the filing is made available to the public
          type: string
        reportDate:
          description: Date as which the filing is reported
          type: string
        form:
          description: Filing Form
          type: string
        amend:
          description: Amendment
          type: boolean
        source:
          description: Filing Source
          type: string
        pageCount:
          description: Estimate number of page when printing
          type: integer
        documentCount:
          description: Number of document in this filing
          type: integer
      type: object
    InFilingResponse:
      properties:
        filingId:
          description: Filing Id in Alpharesearch platform
          type: string
        title:
          description: Filing title
          type: string
        filerId:
          description: Id of the entity submitted the filing
          type: string
        symbol:
          description: List of symbol associate with this filing
          type: object
        name:
          description: Filer name
          type: string
        acceptanceDate:
          description: Date the filing is submitted.
          type: string
        filedDate:
          description: Date the filing is make available to the public
          type: string
        reportDate:
          description: Date as which the filing is reported
          type: string
        form:
          description: Filing Form
          type: string
        amend:
          description: Amendment
          type: boolean
        source:
          description: Filing Source
          type: string
        pageCount:
          description: Estimate number of page when printing
          type: integer
        documentCount:
          description: Number of document in this filing
          type: integer
        documents:
          description: Document for this filing.
          items:
            $ref: '#/components/schemas/DocumentResponse'
          type: array
      type: object
    DocumentResponse:
      properties:
        documentId:
          description: AlphaResearch internal document id.
          type: string
        title:
          description: Title for this document.
          type: string
        hits:
          description: Number of hit in this document
          type: string
        url:
          description: Link to render this document
          type: string
        format:
          description: Format of this document (can be html or pdf)
          type: string
        excerpts:
          description: Highlighted excerpts for this document
          items:
            $ref: '#/components/schemas/ExcerptResponse'
          type: array
      type: object
    ExcerptResponse:
      properties:
        content:
          description: Highlighted content
          type: string
        snippetId:
          description: Location of the content in the rendered document
          type: string
        startOffset:
          description: Start offset of highlighted content
          type: string
        endOffset:
          description: End offset of highlighted content
          type: string
      type: object
    SearchFilter:
      properties:
        id:
          description: Filter id, use with respective field in search query body.
          type: string
        name:
          description: Display name.
          type: string
      type: object
    StockSymbol:
      example:
        displaySymbol: displaySymbol
        symbol: symbol
        mic: mic
        description: description
        figi: figi
        shareClassFIGI: shareClassFIGI
        currency: currency
        type: type
        isin: isin
        symbol2: symbol2
      properties:
        description:
          description: Symbol description
          type: string
        displaySymbol:
          description: Display symbol name.
          type: string
        symbol:
          description: Unique symbol used to identify this symbol used in <code>/stock/candle</code>
            endpoint.
          type: string
        type:
          description: Security type.
          type: string
        mic:
          description: Primary exchange's MIC.
          type: string
        figi:
          description: FIGI identifier.
          type: string
        shareClassFIGI:
          description: Global Share Class FIGI.
          type: string
        currency:
          description: Price's currency. This might be different from the reporting
            currency of fundamental data.
          type: string
        symbol2:
          description: Alternative ticker for exchanges with multiple tickers for
            1 stock such as BSE.
          type: string
        isin:
          description: ISIN. This field is only available for EU stocks and selected
            Asian markets. Entitlement from Finnhub is required to access this field.
          type: string
      type: object
    SymbolLookup:
      example:
        result:
        - displaySymbol: displaySymbol
          symbol: symbol
          description: description
          type: type
        - displaySymbol: displaySymbol
          symbol: symbol
          description: description
          type: type
        count: 0
      properties:
        result:
          description: Array of search results.
          items:
            $ref: '#/components/schemas/SymbolLookupInfo'
          type: array
        count:
          description: Number of results.
          format: int64
          type: integer
      type: object
    SymbolLookupInfo:
      example:
        displaySymbol: displaySymbol
        symbol: symbol
        description: description
        type: type
      properties:
        description:
          description: Symbol description
          type: string
        displaySymbol:
          description: Display symbol name.
          type: string
        symbol:
          description: Unique symbol used to identify this symbol used in <code>/stock/candle</code>
            endpoint.
          type: string
        type:
          description: Security type.
          type: string
      type: object
    InstitutionalPortfolio:
      example:
        cik: cik
        data:
        - reportDate: reportDate
          filingDate: filingDate
          portfolio:
          - noVoting: 6.0274563
            sharedVoting: 5.637377
            symbol: symbol
            cusip: cusip
            change: 0.8008282
            percentage: 1.4658129
            name: name
            share: 5.962134
            soleVoting: 2.302136
            value: 7.0614014
            putCall: putCall
          - noVoting: 6.0274563
            sharedVoting: 5.637377
            symbol: symbol
            cusip: cusip
            change: 0.8008282
            percentage: 1.4658129
            name: name
            share: 5.962134
            soleVoting: 2.302136
            value: 7.0614014
            putCall: putCall
        - reportDate: reportDate
          filingDate: filingDate
          portfolio:
          - noVoting: 6.0274563
            sharedVoting: 5.637377
            symbol: symbol
            cusip: cusip
            change: 0.8008282
            percentage: 1.4658129
            name: name
            share: 5.962134
            soleVoting: 2.302136
            value: 7.0614014
            putCall: putCall
          - noVoting: 6.0274563
            sharedVoting: 5.637377
            symbol: symbol
            cusip: cusip
            change: 0.8008282
            percentage: 1.4658129
            name: name
            share: 5.962134
            soleVoting: 2.302136
            value: 7.0614014
            putCall: putCall
        name: name
      properties:
        name:
          description: Investor's name.
          type: string
        cik:
          description: CIK.
          type: string
        data:
          description: Array of positions.
          items:
            $ref: '#/components/schemas/InstitutionalPortfolioGroup'
          type: array
      type: object
    MarketStatus:
      example:
        isOpen: true
        t: 0
        timezone: timezone
        session: session
        exchange: exchange
        holiday: holiday
      properties:
        exchange:
          description: Exchange.
          type: string
        timezone:
          description: Timezone.
          type: string
        session:
          description: 'Market session. Can be 1 of the following values: <code>pre-market</code>,<code>regular</code>,<code>post-market</code>
            or <code>null</code> if the market is closed.'
          type: string
        holiday:
          description: Holiday event.
          type: string
        isOpen:
          description: Whether the market is open at the moment.
          type: boolean
        t:
          description: Current timestamp.
          format: int64
          type: integer
      type: object
    MarketHolidayData:
      example:
        atDate: atDate
        eventName: eventName
        tradingHour: tradingHour
      properties:
        eventName:
          description: Holiday's name.
          type: string
        atDate:
          description: Date.
          type: string
        tradingHour:
          description: Trading hours for this day if the market is partially closed
            only.
          type: string
      type: object
    MarketHoliday:
      example:
        data:
        - atDate: atDate
          eventName: eventName
          tradingHour: tradingHour
        - atDate: atDate
          eventName: eventName
          tradingHour: tradingHour
        timezone: timezone
        exchange: exchange
      properties:
        timezone:
          description: Timezone.
          type: string
        exchange:
          description: Exchange.
          type: string
        data:
          description: Array of holidays.
          items:
            $ref: '#/components/schemas/MarketHolidayData'
          type: array
      type: object
    CompanyProfile:
      example:
        country: country
        cusip: cusip
        city: city
        naicsSector: naicsSector
        description: description
        employeeTotal: 1.4658129
        estimateCurrency: estimateCurrency
        marketCapCurrency: marketCapCurrency
        gsector: gsector
        lei: lei
        weburl: weburl
        alias:
        - alias
        - alias
        logo: logo
        currency: currency
        state: state
        ggroup: ggroup
        ticker: ticker
        address: address
        marketCapitalization: 0.8008282
        gind: gind
        ipo: 2000-01-23
        sedol: sedol
        finnhubIndustry: finnhubIndustry
        naicsNationalIndustry: naicsNationalIndustry
        naicsSubsector: naicsSubsector
        phone: phone
        gsubind: gsubind
        name: name
        exchange: exchange
        irUrl: irUrl
        naics: naics
        isin: isin
        shareOutstanding: 6.0274563
      properties:
        alias:
          description: Company name alias.
          items:
            type: string
          type: array
        address:
          description: Address of company's headquarter.
          type: string
        city:
          description: City of company's headquarter.
          type: string
        country:
          description: Country of company's headquarter.
          type: string
        currency:
          description: Currency used in company filings and financials.
          type: string
        estimateCurrency:
          description: Currency used in Estimates data.
          type: string
        marketCapCurrency:
          description: Currency used in market capitalization.
          type: string
        cusip:
          description: CUSIP number.
          type: string
        sedol:
          description: Sedol number.
          type: string
        description:
          description: Company business summary.
          type: string
        exchange:
          description: Listed exchange.
          type: string
        ggroup:
          description: Industry group.
          type: string
        gind:
          description: Industry.
          type: string
        gsector:
          description: Sector.
          type: string
        gsubind:
          description: Sub-industry.
          type: string
        isin:
          description: ISIN number.
          type: string
        lei:
          description: LEI number.
          type: string
        irUrl:
          description: Investor relations website.
          type: string
        naicsNationalIndustry:
          description: NAICS national industry.
          type: string
        naics:
          description: NAICS industry.
          type: string
        naicsSector:
          description: NAICS sector.
          type: string
        naicsSubsector:
          description: NAICS subsector.
          type: string
        name:
          description: Company name.
          type: string
        phone:
          description: Company phone number.
          type: string
        state:
          description: State of company's headquarter.
          type: string
        ticker:
          description: Company symbol/ticker as used on the listed exchange.
          type: string
        weburl:
          description: Company website.
          type: string
        ipo:
          description: IPO date.
          format: date
          type: string
        marketCapitalization:
          description: Market Capitalization.
          format: float
          type: number
        shareOutstanding:
          description: Number of oustanding shares.
          format: float
          type: number
        employeeTotal:
          description: Number of employee.
          format: float
          type: number
        logo:
          description: Logo image.
          type: string
        finnhubIndustry:
          description: Finnhub industry classification.
          type: string
      type: object
    CompanyProfile2:
      example:
        finnhubIndustry: finnhubIndustry
        country: country
        ticker: ticker
        marketCapitalization: 0.8008282
        phone: phone
        weburl: weburl
        name: name
        ipo: 2000-01-23
        logo: logo
        currency: currency
        exchange: exchange
        shareOutstanding: 6.0274563
      properties:
        country:
          description: Country of company's headquarter.
          type: string
        currency:
          description: Currency used in company filings.
          type: string
        exchange:
          description: Listed exchange.
          type: string
        name:
          description: Company name.
          type: string
        ticker:
          description: Company symbol/ticker as used on the listed exchange.
          type: string
        ipo:
          description: IPO date.
          format: date
          type: string
        marketCapitalization:
          description: Market Capitalization.
          format: float
          type: number
        shareOutstanding:
          description: Number of oustanding shares.
          format: float
          type: number
        logo:
          description: Logo image.
          type: string
        phone:
          description: Company phone number.
          type: string
        weburl:
          description: Company website.
          type: string
        finnhubIndustry:
          description: Finnhub industry classification.
          type: string
      type: object
    Company:
      example:
        sex: sex
        name: name
        compensation: 6
        currency: currency
        title: title
        age: 0
        since: since
      properties:
        name:
          description: Executive name
          type: string
        age:
          description: Age
          format: int64
          type: integer
        title:
          description: Title
          type: string
        since:
          description: Year first appointed as executive/director of the company
          type: string
        sex:
          description: Sex
          type: string
        compensation:
          description: Total compensation
          format: int64
          type: integer
        currency:
          description: Compensation currency
          type: string
      type: object
    CompanyExecutive:
      example:
        symbol: symbol
        executive:
        - sex: sex
          name: name
          compensation: 6
          currency: currency
          title: title
          age: 0
          since: since
        - sex: sex
          name: name
          compensation: 6
          currency: currency
          title: title
          age: 0
          since: since
      properties:
        symbol:
          description: Company symbol.
          type: string
        executive:
          description: Array of company's executives and members of the Board.
          items:
            $ref: '#/components/schemas/Company'
          type: array
      type: object
    MarketNews:
      example:
        summary: summary
        image: image
        datetime: 0
        related: related
        id: 6
        source: source
        category: category
        headline: headline
        url: url
      properties:
        category:
          description: News category.
          type: string
        datetime:
          description: Published time in UNIX timestamp.
          format: int64
          type: integer
        headline:
          description: News headline.
          type: string
        id:
          description: News ID. This value can be used for <code>minId</code> params
            to get the latest news only.
          format: int64
          type: integer
        image:
          description: Thumbnail image URL.
          type: string
        related:
          description: Related stocks and companies mentioned in the article.
          type: string
        source:
          description: News source.
          type: string
        summary:
          description: News summary.
          type: string
        url:
          description: URL of the original article.
          type: string
      type: object
    CompanyNews:
      example:
        summary: summary
        image: image
        datetime: 0
        related: related
        id: 6
        source: source
        category: category
        headline: headline
        url: url
      properties:
        category:
          description: News category.
          type: string
        datetime:
          description: Published time in UNIX timestamp.
          format: int64
          type: integer
        headline:
          description: News headline.
          type: string
        id:
          description: News ID. This value can be used for <code>minId</code> params
            to get the latest news only.
          format: int64
          type: integer
        image:
          description: Thumbnail image URL.
          type: string
        related:
          description: Related stocks and companies mentioned in the article.
          type: string
        source:
          description: News source.
          type: string
        summary:
          description: News summary.
          type: string
        url:
          description: URL of the original article.
          type: string
      type: object
    Development:
      example:
        symbol: symbol
        datetime: datetime
        description: description
        headline: headline
        url: url
      properties:
        symbol:
          description: Company symbol.
          type: string
        datetime:
          description: Published time in <code>YYYY-MM-DD HH:MM:SS</code> format.
          type: string
        headline:
          description: Development headline.
          type: string
        description:
          description: Development description.
          type: string
        url:
          description: URL.
          type: string
      type: object
    PressRelease:
      example:
        majorDevelopment:
        - symbol: symbol
          datetime: datetime
          description: description
          headline: headline
          url: url
        - symbol: symbol
          datetime: datetime
          description: description
          headline: headline
          url: url
        symbol: symbol
      properties:
        symbol:
          description: Company symbol.
          type: string
        majorDevelopment:
          description: Array of major developments.
          items:
            $ref: '#/components/schemas/Development'
          type: array
      type: object
    NewsroomArticle:
      example:
        atDate: atDate
        fullText: fullText
        title: title
        url: url
      properties:
        atDate:
          description: Published time in <code>YYYY-MM-DD HH:MM:SS</code> format (EST
            timezone).
          type: string
        title:
          description: Title.
          type: string
        fullText:
          description: URL to download the full text data.
          type: string
        url:
          description: Original URL.
          type: string
      type: object
    Newsroom:
      example:
        symbol: symbol
        data:
        - atDate: atDate
          fullText: fullText
          title: title
          url: url
        - atDate: atDate
          fullText: fullText
          title: title
          url: url
      properties:
        symbol:
          description: Company symbol.
          type: string
        data:
          description: Array of articles.
          items:
            $ref: '#/components/schemas/NewsroomArticle'
          type: array
      type: object
    CompanyNewsStatistics:
      example:
        weeklyAverage: 1.4658129
        articlesInLastWeek: 0
        buzz: 6.0274563
      properties:
        articlesInLastWeek:
          description: ""
          format: int64
          type: integer
        buzz:
          description: ""
          format: float
          type: number
        weeklyAverage:
          description: ""
          format: float
          type: number
      type: object
    Sentiment:
      example:
        bearishPercent: 7.0614014
        bullishPercent: 9.301444
      properties:
        bearishPercent:
          description: ""
          format: float
          type: number
        bullishPercent:
          description: ""
          format: float
          type: number
      type: object
    NewsSentiment:
      example:
        sentiment:
          bearishPercent: 7.0614014
          bullishPercent: 9.301444
        symbol: symbol
        sectorAverageBullishPercent: 5.637377
        sectorAverageNewsScore: 2.302136
        buzz:
          weeklyAverage: 1.4658129
          articlesInLastWeek: 0
          buzz: 6.0274563
        companyNewsScore: 5.962134
      properties:
        buzz:
          $ref: '#/components/schemas/CompanyNewsStatistics'
        companyNewsScore:
          description: News score.
          format: float
          type: number
        sectorAverageBullishPercent:
          description: Sector average bullish percent.
          format: float
          type: number
        sectorAverageNewsScore:
          description: Sectore average score.
          format: float
          type: number
        sentiment:
          $ref: '#/components/schemas/Sentiment'
        symbol:
          description: Requested symbol.
          type: string
      type: object
    MetricSeriesMap:
      type: object
    MetricMap:
      type: object
    PriceMetricMap:
      type: object
    BasicFinancials:
      example:
        symbol: symbol
        metricType: metricType
        metric: '{}'
        series: '{}'
      properties:
        symbol:
          description: Symbol of the company.
          type: string
        metricType:
          description: Metric type.
          type: string
        series:
          type: object
        metric:
          type: object
      type: object
    PriceMetrics:
      example:
        symbol: symbol
        data: '{}'
        atDate: atDate
      properties:
        symbol:
          description: Symbol of the company.
          type: string
        atDate:
          description: Data date.
          type: string
        data:
          type: object
      type: object
    CongressionalTransaction:
      example:
        ownerType: ownerType
        transactionType: transactionType
        symbol: symbol
        amountTo: 6.0274563
        filingDate: filingDate
        name: name
        amountFrom: 0.8008282
        assetName: assetName
        position: position
        transactionDate: transactionDate
      properties:
        amountFrom:
          description: Transaction amount from.
          format: float
          type: number
        amountTo:
          description: Transaction amount to.
          format: float
          type: number
        assetName:
          description: Asset name.
          type: string
        filingDate:
          description: Filing date.
          type: string
        name:
          description: Name of the representative.
          type: string
        ownerType:
          description: Owner Type.
          type: string
        position:
          description: Position.
          type: string
        symbol:
          description: Symbol.
          type: string
        transactionDate:
          description: Transaction date.
          type: string
        transactionType:
          description: Transaction type <code>Sale</code> or <code>Purchase</code>.
          type: string
      type: object
    CongressionalTrading:
      example:
        symbol: symbol
        data:
        - ownerType: ownerType
          transactionType: transactionType
          symbol: symbol
          amountTo: 6.0274563
          filingDate: filingDate
          name: name
          amountFrom: 0.8008282
          assetName: assetName
          position: position
          transactionDate: transactionDate
        - ownerType: ownerType
          transactionType: transactionType
          symbol: symbol
          amountTo: 6.0274563
          filingDate: filingDate
          name: name
          amountFrom: 0.8008282
          assetName: assetName
          position: position
          transactionDate: transactionDate
      properties:
        symbol:
          description: Symbol of the company.
          type: string
        data:
          description: Array of stock trades.
          items:
            $ref: '#/components/schemas/CongressionalTransaction'
          type: array
      type: object
    IsinChangeInfo:
      example:
        oldIsin: oldIsin
        atDate: atDate
        newIsin: newIsin
      properties:
        atDate:
          description: Event's date.
          type: string
        oldIsin:
          description: Old ISIN.
          type: string
        newIsin:
          description: New ISIN.
          type: string
      type: object
    IsinChange:
      example:
        fromDate: fromDate
        data:
        - oldIsin: oldIsin
          atDate: atDate
          newIsin: newIsin
        - oldIsin: oldIsin
          atDate: atDate
          newIsin: newIsin
        toDate: toDate
      properties:
        fromDate:
          description: From date.
          type: string
        toDate:
          description: To date.
          type: string
        data:
          description: Array of ISIN change events.
          items:
            $ref: '#/components/schemas/IsinChangeInfo'
          type: array
      type: object
    SymbolChangeInfo:
      example:
        oldSymbol: oldSymbol
        atDate: atDate
        newSymbol: newSymbol
      properties:
        atDate:
          description: Event's date.
          type: string
        oldSymbol:
          description: Old symbol.
          type: string
        newSymbol:
          description: New symbol.
          type: string
      type: object
    SymbolChange:
      example:
        fromDate: fromDate
        data:
        - oldSymbol: oldSymbol
          atDate: atDate
          newSymbol: newSymbol
        - oldSymbol: oldSymbol
          atDate: atDate
          newSymbol: newSymbol
        toDate: toDate
      properties:
        fromDate:
          description: From date.
          type: string
        toDate:
          description: To date.
          type: string
        data:
          description: Array of symbol change events.
          items:
            $ref: '#/components/schemas/SymbolChangeInfo'
          type: array
      type: object
    InstitutionalPortfolioInfo:
      example:
        noVoting: 6.0274563
        sharedVoting: 5.637377
        symbol: symbol
        cusip: cusip
        change: 0.8008282
        percentage: 1.4658129
        name: name
        share: 5.962134
        soleVoting: 2.302136
        value: 7.0614014
        putCall: putCall
      properties:
        symbol:
          description: Symbol.
          type: string
        cusip:
          description: CUSIP.
          type: string
        name:
          description: Position's name.
          type: string
        putCall:
          description: <code>put</code> or <code>call</code> for options.
          type: string
        change:
          description: Number of shares change.
          format: float
          type: number
        noVoting:
          description: Number of shares with no voting rights.
          format: float
          type: number
        percentage:
          description: Percentage of portfolio.
          format: float
          type: number
        share:
          description: Number of shares.
          format: float
          type: number
        sharedVoting:
          description: Number of shares with shared voting rights.
          format: float
          type: number
        soleVoting:
          description: Number of shares with sole voting rights.
          format: float
          type: number
        value:
          description: Position value.
          format: float
          type: number
      type: object
    InstitutionalPortfolioGroup:
      example:
        reportDate: reportDate
        filingDate: filingDate
        portfolio:
        - noVoting: 6.0274563
          sharedVoting: 5.637377
          symbol: symbol
          cusip: cusip
          change: 0.8008282
          percentage: 1.4658129
          name: name
          share: 5.962134
          soleVoting: 2.302136
          value: 7.0614014
          putCall: putCall
        - noVoting: 6.0274563
          sharedVoting: 5.637377
          symbol: symbol
          cusip: cusip
          change: 0.8008282
          percentage: 1.4658129
          name: name
          share: 5.962134
          soleVoting: 2.302136
          value: 7.0614014
          putCall: putCall
      properties:
        reportDate:
          description: Report date.
          type: string
        filingDate:
          description: Filing date.
          type: string
        portfolio:
          description: Array of positions.
          items:
            $ref: '#/components/schemas/InstitutionalPortfolioInfo'
          type: array
      type: object
    InstitutionalOwnershipInfo:
      example:
        noVoting: 6.0274563
        sharedVoting: 5.637377
        cik: cik
        change: 0.8008282
        percentage: 1.4658129
        name: name
        share: 5.962134
        soleVoting: 2.302136
        value: 7.0614014
        putCall: putCall
      properties:
        cik:
          description: Investor's company CIK.
          type: string
        name:
          description: Firm's name.
          type: string
        putCall:
          description: <code>put</code> or <code>call</code> for options.
          type: string
        change:
          description: Number of shares change.
          format: float
          type: number
        noVoting:
          description: Number of shares with no voting rights.
          format: float
          type: number
        percentage:
          description: Percentage of portfolio.
          format: float
          type: number
        share:
          description: News score.
          format: float
          type: number
        sharedVoting:
          description: Number of shares with shared voting rights.
          format: float
          type: number
        soleVoting:
          description: Number of shares with sole voting rights.
          format: float
          type: number
        value:
          description: Position value.
          format: float
          type: number
      type: object
    InstitutionalOwnershipGroup:
      example:
        reportDate: reportDate
        ownership:
        - noVoting: 6.0274563
          sharedVoting: 5.637377
          cik: cik
          change: 0.8008282
          percentage: 1.4658129
          name: name
          share: 5.962134
          soleVoting: 2.302136
          value: 7.0614014
          putCall: putCall
        - noVoting: 6.0274563
          sharedVoting: 5.637377
          cik: cik
          change: 0.8008282
          percentage: 1.4658129
          name: name
          share: 5.962134
          soleVoting: 2.302136
          value: 7.0614014
          putCall: putCall
      properties:
        reportDate:
          description: Report date.
          type: string
        ownership:
          description: Array of institutional investors.
          items:
            $ref: '#/components/schemas/InstitutionalOwnershipInfo'
          type: array
      type: object
    InstitutionalOwnership:
      example:
        symbol: symbol
        cusip: cusip
        data:
        - reportDate: reportDate
          ownership:
          - noVoting: 6.0274563
            sharedVoting: 5.637377
            cik: cik
            change: 0.8008282
            percentage: 1.4658129
            name: name
            share: 5.962134
            soleVoting: 2.302136
            value: 7.0614014
            putCall: putCall
          - noVoting: 6.0274563
            sharedVoting: 5.637377
            cik: cik
            change: 0.8008282
            percentage: 1.4658129
            name: name
            share: 5.962134
            soleVoting: 2.302136
            value: 7.0614014
            putCall: putCall
        - reportDate: reportDate
          ownership:
          - noVoting: 6.0274563
            sharedVoting: 5.637377
            cik: cik
            change: 0.8008282
            percentage: 1.4658129
            name: name
            share: 5.962134
            soleVoting: 2.302136
            value: 7.0614014
            putCall: putCall
          - noVoting: 6.0274563
            sharedVoting: 5.637377
            cik: cik
            change: 0.8008282
            percentage: 1.4658129
            name: name
            share: 5.962134
            soleVoting: 2.302136
            value: 7.0614014
            putCall: putCall
      properties:
        symbol:
          description: Symbol.
          type: string
        cusip:
          description: Cusip.
          type: string
        data:
          description: Array of institutional investors.
          items:
            $ref: '#/components/schemas/InstitutionalOwnershipGroup'
          type: array
      type: object
    InstitutionalProfileInfo:
      example:
        cik: cik
        manager: manager
        profile: profile
        philosophy: philosophy
        profileImg: profileImg
        firmType: firmType
      properties:
        cik:
          description: Investor's company CIK.
          type: string
        firmType:
          description: Firm type.
          type: string
        manager:
          description: Manager.
          type: string
        philosophy:
          description: Investing philosophy.
          type: string
        profile:
          description: Profile info.
          type: string
        profileImg:
          description: Profile image.
          type: string
      type: object
    InstitutionalProfile:
      example:
        cik: cik
        data:
        - cik: cik
          manager: manager
          profile: profile
          philosophy: philosophy
          profileImg: profileImg
          firmType: firmType
        - cik: cik
          manager: manager
          profile: profile
          philosophy: philosophy
          profileImg: profileImg
          firmType: firmType
      properties:
        cik:
          description: CIK.
          type: string
        data:
          description: Array of investors.
          items:
            $ref: '#/components/schemas/InstitutionalProfileInfo'
          type: array
      type: object
    OwnershipInfo:
      example:
        filingDate: 2000-01-23
        change: 6
        name: name
        share: 0
      properties:
        name:
          description: Investor's name.
          type: string
        share:
          description: Number of shares held by the investor.
          format: int64
          type: integer
        change:
          description: Number of share changed (net buy or sell) from the last period.
          format: int64
          type: integer
        filingDate:
          description: Filing date.
          format: date
          type: string
      type: object
    Ownership:
      example:
        symbol: symbol
        ownership:
        - filingDate: 2000-01-23
          change: 6
          name: name
          share: 0
        - filingDate: 2000-01-23
          change: 6
          name: name
          share: 0
      properties:
        symbol:
          description: Symbol of the company.
          type: string
        ownership:
          description: Array of investors with detailed information about their holdings.
          items:
            $ref: '#/components/schemas/OwnershipInfo'
          type: array
      type: object
    FundOwnershipInfo:
      example:
        filingDate: 2000-01-23
        portfolioPercent: 1.4658129
        change: 6
        name: name
        share: 0
      properties:
        name:
          description: Investor's name.
          type: string
        share:
          description: Number of shares held by the investor.
          format: int64
          type: integer
        change:
          description: Number of share changed (net buy or sell) from the last period.
          format: int64
          type: integer
        filingDate:
          description: Filing date.
          format: date
          type: string
        portfolioPercent:
          description: Percent of the fund's portfolio comprised of the company's
            share.
          format: float
          type: number
      type: object
    FundOwnership:
      example:
        symbol: symbol
        ownership:
        - filingDate: 2000-01-23
          portfolioPercent: 1.4658129
          change: 6
          name: name
          share: 0
        - filingDate: 2000-01-23
          portfolioPercent: 1.4658129
          change: 6
          name: name
          share: 0
      properties:
        symbol:
          description: Symbol of the company.
          type: string
        ownership:
          description: Array of investors with detailed information about their holdings.
          items:
            $ref: '#/components/schemas/FundOwnershipInfo'
          type: array
      type: object
    Transactions:
      example:
        symbol: symbol
        filingDate: 2000-01-23
        change: 6
        name: name
        transactionPrice: 1.4658129
        share: 0
        transactionCode: transactionCode
        transactionDate: 2000-01-23
      properties:
        symbol:
          description: Symbol.
          type: string
        name:
          description: Insider's name.
          type: string
        share:
          description: Number of shares held after the transaction.
          format: int64
          type: integer
        change:
          description: Number of share changed from the last period. A positive value
            suggests a <code>BUY</code> transaction. A negative value suggests a <code>SELL</code>
            transaction.
          format: int64
          type: integer
        filingDate:
          description: Filing date.
          format: date
          type: string
        transactionDate:
          description: Transaction date.
          format: date
          type: string
        transactionPrice:
          description: Average transaction price.
          format: float
          type: number
        transactionCode:
          description: Transaction code. A list of codes and their meanings can be
            found <a href="https://www.sec.gov/about/forms/form4data.pdf" target="_blank"
            rel="noopener">here</a>.
          type: string
      type: object
    InsiderTransactions:
      example:
        symbol: symbol
        data:
        - symbol: symbol
          filingDate: 2000-01-23
          change: 6
          name: name
          transactionPrice: 1.4658129
          share: 0
          transactionCode: transactionCode
          transactionDate: 2000-01-23
        - symbol: symbol
          filingDate: 2000-01-23
          change: 6
          name: name
          transactionPrice: 1.4658129
          share: 0
          transactionCode: transactionCode
          transactionDate: 2000-01-23
      properties:
        symbol:
          description: Symbol of the company.
          type: string
        data:
          description: Array of insider transactions.
          items:
            $ref: '#/components/schemas/Transactions'
          type: array
      type: object
    InsiderSentimentsData:
      example:
        symbol: symbol
        month: 6
        year: 0
        change: 1
        mspr: 5.962134
      properties:
        symbol:
          description: Symbol.
          type: string
        year:
          description: Year.
          format: int64
          type: integer
        month:
          description: Month.
          format: int64
          type: integer
        change:
          description: Net buying/selling from all insiders' transactions.
          format: int64
          type: integer
        mspr:
          description: Monthly share purchase ratio.
          format: float
          type: number
      type: object
    InsiderSentiments:
      example:
        symbol: symbol
        data:
        - symbol: symbol
          month: 6
          year: 0
          change: 1
          mspr: 5.962134
        - symbol: symbol
          month: 6
          year: 0
          change: 1
          mspr: 5.962134
      properties:
        symbol:
          description: Symbol of the company.
          type: string
        data:
          description: Array of sentiment data.
          items:
            $ref: '#/components/schemas/InsiderSentimentsData'
          type: array
      type: object
    FinancialMap:
      type: object
    FinancialStatements:
      example:
        symbol: symbol
        financials:
        - null
        - null
      properties:
        symbol:
          description: Symbol of the company.
          type: string
        financials:
          description: An array of map of key, value pairs containing the data for
            each period.
          items:
            $ref: '#/components/schemas/FinancialMap'
          type: array
      type: object
    ReportDataMap:
      type: object
    Report:
      example:
        symbol: symbol
        cik: cik
        form: form
        accessNumber: accessNumber
        year: 0
        endDate: endDate
        report: '{}'
        filedDate: filedDate
        acceptedDate: acceptedDate
        startDate: startDate
        quarter: 6
      properties:
        accessNumber:
          description: Access number.
          type: string
        symbol:
          description: Symbol.
          type: string
        cik:
          description: CIK.
          type: string
        year:
          description: Year.
          format: int64
          type: integer
        quarter:
          description: Quarter.
          format: int64
          type: integer
        form:
          description: Form type.
          type: string
        startDate:
          description: Period start date <code>%Y-%m-%d %H:%M:%S</code>.
          type: string
        endDate:
          description: Period end date <code>%Y-%m-%d %H:%M:%S</code>.
          type: string
        filedDate:
          description: Filed date <code>%Y-%m-%d %H:%M:%S</code>.
          type: string
        acceptedDate:
          description: Accepted date <code>%Y-%m-%d %H:%M:%S</code>.
          type: string
        report:
          type: object
      type: object
    FinancialsAsReported:
      example:
        symbol: symbol
        cik: cik
        data:
        - symbol: symbol
          cik: cik
          form: form
          accessNumber: accessNumber
          year: 0
          endDate: endDate
          report: '{}'
          filedDate: filedDate
          acceptedDate: acceptedDate
          startDate: startDate
          quarter: 6
        - symbol: symbol
          cik: cik
          form: form
          accessNumber: accessNumber
          year: 0
          endDate: endDate
          report: '{}'
          filedDate: filedDate
          acceptedDate: acceptedDate
          startDate: startDate
          quarter: 6
      properties:
        symbol:
          description: Symbol
          type: string
        cik:
          description: CIK
          type: string
        data:
          description: Array of filings.
          items:
            $ref: '#/components/schemas/Report'
          type: array
      type: object
    BreakdownItemMap:
      type: object
    BreakdownItem:
      example:
        accessNumber: accessNumber
        breakdown: '{}'
      properties:
        accessNumber:
          description: Access number of the report from which the data is sourced.
          type: string
        breakdown:
          type: object
      type: object
    RevenueBreakdown:
      example:
        symbol: symbol
        cik: cik
        data:
        - accessNumber: accessNumber
          breakdown: '{}'
        - accessNumber: accessNumber
          breakdown: '{}'
      properties:
        symbol:
          description: Symbol
          type: string
        cik:
          description: CIK
          type: string
        data:
          description: Array of revenue breakdown over multiple periods.
          items:
            $ref: '#/components/schemas/BreakdownItem'
          type: array
      type: object
    RevenueBreakdown2:
      example:
        symbol: symbol
        data: '{}'
        currency: currency
      properties:
        symbol:
          description: Symbol
          type: string
        currency:
          description: currency
          type: string
        data:
          description: Revenue breakdown data.
          properties: {}
          type: object
      type: object
    Filing:
      example:
        symbol: symbol
        cik: cik
        form: form
        accessNumber: accessNumber
        reportUrl: reportUrl
        filedDate: filedDate
        acceptedDate: acceptedDate
        filingUrl: filingUrl
      properties:
        accessNumber:
          description: Access number.
          type: string
        symbol:
          description: Symbol.
          type: string
        cik:
          description: CIK.
          type: string
        form:
          description: Form type.
          type: string
        filedDate:
          description: Filed date <code>%Y-%m-%d %H:%M:%S</code>.
          type: string
        acceptedDate:
          description: Accepted date <code>%Y-%m-%d %H:%M:%S</code>.
          type: string
        reportUrl:
          description: Report's URL.
          type: string
        filingUrl:
          description: Filing's URL.
          type: string
      type: object
    InternationalFiling:
      example:
        symbol: symbol
        country: country
        companyName: companyName
        description: description
        language: language
        category: category
        title: title
        filedDate: filedDate
        url: url
      properties:
        symbol:
          description: Symbol.
          type: string
        companyName:
          description: Company name.
          type: string
        filedDate:
          description: Filed date <code>%Y-%m-%d %H:%M:%S</code>.
          type: string
        category:
          description: Category.
          type: string
        title:
          description: Document's title.
          type: string
        description:
          description: Document's description.
          type: string
        url:
          description: Url.
          type: string
        language:
          description: Language.
          type: string
        country:
          description: Country.
          type: string
      type: object
    FilingSentiment:
      example:
        modal-strong: 9.301444
        negative: 0.8008282
        constraining: 2.302136
        modal-weak: 7.0614014
        modal-moderate: 3.6160767
        positive: 6.0274563
        uncertainty: 5.637377
        polarity: 1.4658129
        litigious: 5.962134
      properties:
        negative:
          description: '% of negative words in the filing.'
          format: float
          type: number
        positive:
          description: '% of positive words in the filing.'
          format: float
          type: number
        polarity:
          description: '% of polarity words in the filing.'
          format: float
          type: number
        litigious:
          description: '% of litigious words in the filing.'
          format: float
          type: number
        uncertainty:
          description: '% of uncertainty words in the filing.'
          format: float
          type: number
        constraining:
          description: '% of constraining words in the filing.'
          format: float
          type: number
        modal-weak:
          description: '% of modal-weak words in the filing.'
          format: float
          type: number
        modal-strong:
          description: '% of modal-strong words in the filing.'
          format: float
          type: number
        modal-moderate:
          description: '% of modal-moderate words in the filing.'
          format: float
          type: number
      type: object
    SECSentimentAnalysis:
      example:
        symbol: symbol
        sentiment:
          modal-strong: 9.301444
          negative: 0.8008282
          constraining: 2.302136
          modal-weak: 7.0614014
          modal-moderate: 3.6160767
          positive: 6.0274563
          uncertainty: 5.637377
          polarity: 1.4658129
          litigious: 5.962134
        cik: cik
        accessNumber: accessNumber
      properties:
        accessNumber:
          description: Access number.
          type: string
        symbol:
          description: Symbol.
          type: string
        cik:
          description: CIK.
          type: string
        sentiment:
          $ref: '#/components/schemas/FilingSentiment'
      type: object
    SimilarityIndexInfo:
      example:
        item2: 1.4658129
        item7a: 5.637377
        item1: 0.8008282
        cik: cik
        form: form
        accessNumber: accessNumber
        item7: 5.962134
        reportUrl: reportUrl
        item1a: 6.0274563
        filedDate: filedDate
        acceptedDate: acceptedDate
        filingUrl: filingUrl
      properties:
        cik:
          description: CIK.
          type: string
        item1:
          description: Cosine similarity of Item 1 (Business). This number is only
            available for Annual reports.
          format: float
          type: number
        item1a:
          description: Cosine similarity of Item 1A (Risk Factors). This number is
            available for both Annual and Quarterly reports.
          format: float
          type: number
        item2:
          description: Cosine similarity of Item 2 (Management’s Discussion and Analysis
            of Financial Condition and Results of Operations). This number is only
            available for Quarterly reports.
          format: float
          type: number
        item7:
          description: Cosine similarity of Item 7 (Management’s Discussion and Analysis
            of Financial Condition and Results of Operations). This number is only
            available for Annual reports.
          format: float
          type: number
        item7a:
          description: Cosine similarity of Item 7A (Quantitative and Qualitative
            Disclosures About Market Risk). This number is only available for Annual
            reports.
          format: float
          type: number
        accessNumber:
          description: Access number.
          type: string
        form:
          description: Form type.
          type: string
        filedDate:
          description: Filed date <code>%Y-%m-%d %H:%M:%S</code>.
          type: string
        acceptedDate:
          description: Accepted date <code>%Y-%m-%d %H:%M:%S</code>.
          type: string
        reportUrl:
          description: Report's URL.
          type: string
        filingUrl:
          description: Filing's URL.
          type: string
      type: object
    SimilarityIndex:
      example:
        symbol: symbol
        cik: cik
        similarity:
        - item2: 1.4658129
          item7a: 5.637377
          item1: 0.8008282
          cik: cik
          form: form
          accessNumber: accessNumber
          item7: 5.962134
          reportUrl: reportUrl
          item1a: 6.0274563
          filedDate: filedDate
          acceptedDate: acceptedDate
          filingUrl: filingUrl
        - item2: 1.4658129
          item7a: 5.637377
          item1: 0.8008282
          cik: cik
          form: form
          accessNumber: accessNumber
          item7: 5.962134
          reportUrl: reportUrl
          item1a: 6.0274563
          filedDate: filedDate
          acceptedDate: acceptedDate
          filingUrl: filingUrl
      properties:
        symbol:
          description: Symbol.
          type: string
        cik:
          description: CIK.
          type: string
        similarity:
          description: Array of filings with its cosine similarity compared to the
            same report of the previous year.
          items:
            $ref: '#/components/schemas/SimilarityIndexInfo'
          type: array
      type: object
    IPOEvent:
      example:
        date: 2000-01-23
        symbol: symbol
        price: price
        numberOfShares: 0.8008282
        totalSharesValue: 6.0274563
        name: name
        exchange: exchange
        status: status
      properties:
        symbol:
          description: Symbol.
          type: string
        date:
          description: IPO date.
          format: date
          type: string
        exchange:
          description: Exchange.
          type: string
        name:
          description: Company's name.
          type: string
        status:
          description: 'IPO status. Can take 1 of the following values: <code>expected</code>,<code>priced</code>,<code>withdrawn</code>,<code>filed</code>'
          type: string
        price:
          description: Projected price or price range.
          type: string
        numberOfShares:
          description: Number of shares offered during the IPO.
          format: float
          type: number
        totalSharesValue:
          description: Total shares value.
          format: float
          type: number
      type: object
    IPOCalendar:
      example:
        ipoCalendar:
        - date: 2000-01-23
          symbol: symbol
          price: price
          numberOfShares: 0.8008282
          totalSharesValue: 6.0274563
          name: name
          exchange: exchange
          status: status
        - date: 2000-01-23
          symbol: symbol
          price: price
          numberOfShares: 0.8008282
          totalSharesValue: 6.0274563
          name: name
          exchange: exchange
          status: status
      properties:
        ipoCalendar:
          description: Array of IPO events.
          items:
            $ref: '#/components/schemas/IPOEvent'
          type: array
      type: object
    Dividends:
      example:
        date: 2000-01-23
        symbol: symbol
        amount: 0.8008282
        declarationDate: 2000-01-23
        adjustedAmount: 6.0274563
        freq: freq
        recordDate: 2000-01-23
        currency: currency
        payDate: 2000-01-23
      properties:
        symbol:
          description: Symbol.
          type: string
        date:
          description: Ex-Dividend date.
          format: date
          type: string
        amount:
          description: Amount in local currency.
          format: float
          type: number
        adjustedAmount:
          description: Adjusted dividend.
          format: float
          type: number
        payDate:
          description: Pay date.
          format: date
          type: string
        recordDate:
          description: Record date.
          format: date
          type: string
        declarationDate:
          description: Declaration date.
          format: date
          type: string
        currency:
          description: Currency.
          type: string
        freq:
          description: |-
            <p>Dividend frequency. Can be 1 of the following values:</p><ul>
            <li><code>0: Annually</code></li>
            <li><code>1: Monthly</code></li>
            <li><code>2: Quarterly</code></li>
            <li><code>3: Semi-annually</code></li>
            <li><code>4: Other/Unknown</code></li>
            <li><code>5: Bimonthly</code></li>
            <li><code>6: Trimesterly</code></li>
            <li><code>7: Weekly</code></li>
            </ul>
          type: string
      type: object
    Dividends2Info:
      example:
        amount: 0.8008282
        exDate: 2000-01-23
      properties:
        exDate:
          description: Ex-Dividend date.
          format: date
          type: string
        amount:
          description: Amount in local currency.
          format: float
          type: number
      type: object
    RecommendationTrend:
      example:
        symbol: symbol
        period: period
        buy: 0
        sell: 1
        strongSell: 5
        strongBuy: 5
        hold: 6
      properties:
        symbol:
          description: Company symbol.
          type: string
        buy:
          description: Number of recommendations that fall into the Buy category
          format: int64
          type: integer
        hold:
          description: Number of recommendations that fall into the Hold category
          format: int64
          type: integer
        period:
          description: Updated period
          type: string
        sell:
          description: Number of recommendations that fall into the Sell category
          format: int64
          type: integer
        strongBuy:
          description: Number of recommendations that fall into the Strong Buy category
          format: int64
          type: integer
        strongSell:
          description: Number of recommendations that fall into the Strong Sell category
          format: int64
          type: integer
      type: object
    PriceTarget:
      example:
        targetLow: 6.0274563
        symbol: symbol
        lastUpdated: lastUpdated
        numberAnalysts: 5
        targetHigh: 0.8008282
        targetMean: 1.4658129
        targetMedian: 5.962134
      properties:
        symbol:
          description: Company symbol.
          type: string
        targetHigh:
          description: Highes analysts' target.
          format: float
          type: number
        targetLow:
          description: Lowest analysts' target.
          format: float
          type: number
        targetMean:
          description: Mean of all analysts' targets.
          format: float
          type: number
        targetMedian:
          description: Median of all analysts' targets.
          format: float
          type: number
        numberAnalysts:
          description: Number of Analysts.
          format: int64
          type: integer
        lastUpdated:
          description: Updated time of the data
          type: string
      type: object
    UpgradeDowngrade:
      example:
        symbol: symbol
        gradeTime: 0
        fromGrade: fromGrade
        toGrade: toGrade
        action: action
        company: company
      properties:
        symbol:
          description: Company symbol.
          type: string
        gradeTime:
          description: Upgrade/downgrade time in UNIX timestamp.
          format: int64
          type: integer
        fromGrade:
          description: From grade.
          type: string
        toGrade:
          description: To grade.
          type: string
        company:
          description: Company/analyst who did the upgrade/downgrade.
          type: string
        action:
          description: 'Action can take any of the following values: <code>up(upgrade),
            down(downgrade), main(maintains), init(initiate), reit(reiterate)</code>.'
          type: string
      type: object
    RevenueEstimatesInfo:
      example:
        revenueLow: 1.4658129
        period: 2000-01-23
        year: 5
        numberAnalysts: 5
        revenueHigh: 6.0274563
        revenueAvg: 0.8008282
        quarter: 2
      properties:
        revenueAvg:
          description: Average revenue estimates including Finnhub's proprietary estimates.
          format: float
          type: number
        revenueHigh:
          description: Highest estimate.
          format: float
          type: number
        revenueLow:
          description: Lowest estimate.
          format: float
          type: number
        numberAnalysts:
          description: Number of Analysts.
          format: int64
          type: integer
        period:
          description: Period.
          format: date
          type: string
        year:
          description: Fiscal year.
          format: int64
          type: integer
        quarter:
          description: Fiscal quarter.
          format: int64
          type: integer
      type: object
    RevenueEstimates:
      example:
        symbol: symbol
        data:
        - revenueLow: 1.4658129
          period: 2000-01-23
          year: 5
          numberAnalysts: 5
          revenueHigh: 6.0274563
          revenueAvg: 0.8008282
          quarter: 2
        - revenueLow: 1.4658129
          period: 2000-01-23
          year: 5
          numberAnalysts: 5
          revenueHigh: 6.0274563
          revenueAvg: 0.8008282
          quarter: 2
        freq: freq
      properties:
        data:
          description: List of estimates
          items:
            $ref: '#/components/schemas/RevenueEstimatesInfo'
          type: array
        freq:
          description: 'Frequency: annual or quarterly.'
          type: string
        symbol:
          description: Company symbol.
          type: string
      type: object
    EbitdaEstimatesInfo:
      example:
        period: 2000-01-23
        year: 5
        numberAnalysts: 5
        ebitdaAvg: 0.8008282
        ebitdaLow: 1.4658129
        ebitdaHigh: 6.0274563
        quarter: 2
      properties:
        ebitdaAvg:
          description: Average EBITDA estimates including Finnhub's proprietary estimates.
          format: float
          type: number
        ebitdaHigh:
          description: Highest estimate.
          format: float
          type: number
        ebitdaLow:
          description: Lowest estimate.
          format: float
          type: number
        numberAnalysts:
          description: Number of Analysts.
          format: int64
          type: integer
        period:
          description: Period.
          format: date
          type: string
        year:
          description: Fiscal year.
          format: int64
          type: integer
        quarter:
          description: Fiscal quarter.
          format: int64
          type: integer
      type: object
    EbitdaEstimates:
      example:
        symbol: symbol
        data:
        - period: 2000-01-23
          year: 5
          numberAnalysts: 5
          ebitdaAvg: 0.8008282
          ebitdaLow: 1.4658129
          ebitdaHigh: 6.0274563
          quarter: 2
        - period: 2000-01-23
          year: 5
          numberAnalysts: 5
          ebitdaAvg: 0.8008282
          ebitdaLow: 1.4658129
          ebitdaHigh: 6.0274563
          quarter: 2
        freq: freq
      properties:
        data:
          description: List of estimates
          items:
            $ref: '#/components/schemas/EbitdaEstimatesInfo'
          type: array
        freq:
          description: 'Frequency: annual or quarterly.'
          type: string
        symbol:
          description: Company symbol.
          type: string
      type: object
    EbitEstimatesInfo:
      example:
        ebitHigh: 6.0274563
        ebitLow: 1.4658129
        period: 2000-01-23
        year: 5
        numberAnalysts: 5
        ebitAvg: 0.8008282
        quarter: 2
      properties:
        ebitAvg:
          description: Average EBIT estimates including Finnhub's proprietary estimates.
          format: float
          type: number
        ebitHigh:
          description: Highest estimate.
          format: float
          type: number
        ebitLow:
          description: Lowest estimate.
          format: float
          type: number
        numberAnalysts:
          description: Number of Analysts.
          format: int64
          type: integer
        period:
          description: Period.
          format: date
          type: string
        year:
          description: Fiscal year.
          format: int64
          type: integer
        quarter:
          description: Fiscal quarter.
          format: int64
          type: integer
      type: object
    EbitEstimates:
      example:
        symbol: symbol
        data:
        - ebitHigh: 6.0274563
          ebitLow: 1.4658129
          period: 2000-01-23
          year: 5
          numberAnalysts: 5
          ebitAvg: 0.8008282
          quarter: 2
        - ebitHigh: 6.0274563
          ebitLow: 1.4658129
          period: 2000-01-23
          year: 5
          numberAnalysts: 5
          ebitAvg: 0.8008282
          quarter: 2
        freq: freq
      properties:
        data:
          description: List of estimates
          items:
            $ref: '#/components/schemas/EbitEstimatesInfo'
          type: array
        freq:
          description: 'Frequency: annual or quarterly.'
          type: string
        symbol:
          description: Company symbol.
          type: string
      type: object
    EarningsEstimatesInfo:
      example:
        epsHigh: 6.0274563
        period: 2000-01-23
        epsAvg: 0.8008282
        epsLow: 1.4658129
        year: 5
        numberAnalysts: 5
        quarter: 2
      properties:
        epsAvg:
          description: Average EPS estimates including Finnhub's proprietary estimates.
          format: float
          type: number
        epsHigh:
          description: Highest estimate.
          format: float
          type: number
        epsLow:
          description: Lowest estimate.
          format: float
          type: number
        numberAnalysts:
          description: Number of Analysts.
          format: int64
          type: integer
        period:
          description: Period.
          format: date
          type: string
        year:
          description: Fiscal year.
          format: int64
          type: integer
        quarter:
          description: Fiscal quarter.
          format: int64
          type: integer
      type: object
    EarningsEstimates:
      example:
        symbol: symbol
        data:
        - epsHigh: 6.0274563
          period: 2000-01-23
          epsAvg: 0.8008282
          epsLow: 1.4658129
          year: 5
          numberAnalysts: 5
          quarter: 2
        - epsHigh: 6.0274563
          period: 2000-01-23
          epsAvg: 0.8008282
          epsLow: 1.4658129
          year: 5
          numberAnalysts: 5
          quarter: 2
        freq: freq
      properties:
        data:
          description: List of estimates
          items:
            $ref: '#/components/schemas/EarningsEstimatesInfo'
          type: array
        freq:
          description: 'Frequency: annual or quarterly.'
          type: string
        symbol:
          description: Company symbol.
          type: string
      type: object
    EarningResult:
      example:
        actual: 0.8008282
        surprise: 1.4658129
        symbol: symbol
        period: 2000-01-23
        year: 5
        surprisePercent: 5.962134
        estimate: 6.0274563
        quarter: 2
      properties:
        actual:
          description: Actual earning result.
          format: float
          type: number
        estimate:
          description: Estimated earning.
          format: float
          type: number
        surprise:
          description: Surprise - The difference between actual and estimate.
          format: float
          type: number
        surprisePercent:
          description: Surprise percent.
          format: float
          type: number
        period:
          description: Reported period.
          format: date
          type: string
        symbol:
          description: Company symbol.
          type: string
        year:
          description: Fiscal year.
          format: int64
          type: integer
        quarter:
          description: Fiscal quarter.
          format: int64
          type: integer
      type: object
    EarningRelease:
      example:
        date: 2000-01-23
        symbol: symbol
        epsActual: 5.962134
        hour: hour
        epsEstimate: 1.4658129
        revenueEstimate: 5.637377
        revenueActual: 2.302136
        year: 0
        quarter: 6
      properties:
        symbol:
          description: Symbol.
          type: string
        date:
          description: Date.
          format: date
          type: string
        hour:
          description: 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
        year:
          description: Earnings year.
          format: int64
          type: integer
        quarter:
          description: Earnings quarter.
          format: int64
          type: integer
        epsEstimate:
          description: EPS estimate.
          format: float
          type: number
        epsActual:
          description: EPS actual.
          format: float
          type: number
        revenueEstimate:
          description: Revenue estimate including Finnhub's proprietary estimates.
          format: float
          type: number
        revenueActual:
          description: Revenue actual.
          format: float
          type: number
      type: object
    EarningsCalendar:
      example:
        earningsCalendar:
        - date: 2000-01-23
          symbol: symbol
          epsActual: 5.962134
          hour: hour
          epsEstimate: 1.4658129
          revenueEstimate: 5.637377
          revenueActual: 2.302136
          year: 0
          quarter: 6
        - date: 2000-01-23
          symbol: symbol
          epsActual: 5.962134
          hour: hour
          epsEstimate: 1.4658129
          revenueEstimate: 5.637377
          revenueActual: 2.302136
          year: 0
          quarter: 6
      properties:
        earningsCalendar:
          description: Array of earnings release.
          items:
            $ref: '#/components/schemas/EarningRelease'
          type: array
      type: object
    EarningsCallLiveResult:
      example:
        symbol: symbol
        year: 0
        liveAudio: liveAudio
        recording: recording
        time: time
        event: event
        quarter: 6
      properties:
        symbol:
          description: Symbol.
          type: string
        event:
          description: Event name.
          type: string
        time:
          description: Date time in UTC.
          format: datetime
          type: string
        year:
          description: Earnings year.
          format: int64
          type: integer
        quarter:
          description: Earnings quarter.
          format: int64
          type: integer
        liveAudio:
          description: Live audio streaming file.
          type: string
        recording:
          description: Recoding in mp3 format.
          type: string
      type: object
    EarningsCallLive:
      example:
        event:
        - symbol: symbol
          year: 0
          liveAudio: liveAudio
          recording: recording
          time: time
          event: event
          quarter: 6
        - symbol: symbol
          year: 0
          liveAudio: liveAudio
          recording: recording
          time: time
          event: event
          quarter: 6
      properties:
        event:
          description: Array of earnings call events that support live streaming.
          items:
            $ref: '#/components/schemas/EarningsCallLiveResult'
          type: array
      type: object
    Quote:
      example:
        c: 5.962134
        pc: 5.637377
        d: 2.302136
        h: 6.0274563
        l: 1.4658129
        dp: 7.0614014
        o: 0.8008282
      properties:
        o:
          description: Open price of the day
          format: float
          type: number
        h:
          description: High price of the day
          format: float
          type: number
        l:
          description: Low price of the day
          format: float
          type: number
        c:
          description: Current price
          format: float
          type: number
        pc:
          description: Previous close price
          format: float
          type: number
        d:
          description: Change
          format: float
          type: number
        dp:
          description: Percent change
          format: float
          type: number
      type: object
    StockCandles:
      example:
        c:
        - 5.962134
        - 5.962134
        s: s
        t:
        - 2
        - 2
        v:
        - 5.637377
        - 5.637377
        h:
        - 6.0274563
        - 6.0274563
        l:
        - 1.4658129
        - 1.4658129
        o:
        - 0.8008282
        - 0.8008282
      properties:
        o:
          description: List of open prices for returned candles.
          items:
            format: float
            type: number
          type: array
        h:
          description: List of high prices for returned candles.
          items:
            format: float
            type: number
          type: array
        l:
          description: List of low prices for returned candles.
          items:
            format: float
            type: number
          type: array
        c:
          description: List of close prices for returned candles.
          items:
            format: float
            type: number
          type: array
        v:
          description: List of volume data for returned candles.
          items:
            format: float
            type: number
          type: array
        t:
          description: List of timestamp for returned candles.
          items:
            format: int64
            type: integer
          type: array
        s:
          description: Status of the response. This field can either be ok or no_data.
          type: string
      type: object
    TickData:
      example:
        p:
        - 5.637377
        - 5.637377
        total: 1
        s: s
        c:
        - - c
          - c
        - - c
          - c
        t:
        - 2
        - 2
        v:
        - 5.962134
        - 5.962134
        count: 6
        x:
        - x
        - x
        skip: 0
      properties:
        s:
          description: Symbol.
          type: string
        skip:
          description: Number of ticks skipped.
          format: int64
          type: integer
        count:
          description: Number of ticks returned. If <code>count</code> < <code>limit</code>,
            all data for that date has been returned.
          format: int64
          type: integer
        total:
          description: Total number of ticks for that date.
          format: int64
          type: integer
        v:
          description: List of volume data.
          items:
            format: float
            type: number
          type: array
        p:
          description: List of price data.
          items:
            format: float
            type: number
          type: array
        t:
          description: List of timestamp in UNIX ms.
          items:
            format: int64
            type: integer
          type: array
        x:
          description: List of venues/exchanges. 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>
          items:
            type: string
          type: array
        c:
          description: List of trade conditions. A comprehensive list of trade conditions
            code can be found <a target="_blank" href="https://docs.google.com/spreadsheets/d/1PUxiSWPHSODbaTaoL2Vef6DgU-yFtlRGZf19oBb9Hp0/edit?usp=sharing">here</a>
          items:
            items:
              type: string
            type: array
          type: array
      type: object
    BondTickData:
      example:
        p:
        - 5.637377
        - 5.637377
        ats:
        - ats
        - ats
        total: 1
        c:
        - - c
          - c
        - - c
          - c
        t:
        - 7
        - 7
        v:
        - 5.962134
        - 5.962134
        si:
        - si
        - si
        count: 6
        y:
        - 2.302136
        - 2.302136
        skip: 0
        cp:
        - cp
        - cp
        rp:
        - rp
        - rp
      properties:
        skip:
          description: Number of ticks skipped.
          format: int64
          type: integer
        count:
          description: Number of ticks returned. If <code>count</code> < <code>limit</code>,
            all data for that date has been returned.
          format: int64
          type: integer
        total:
          description: Total number of ticks for that date.
          format: int64
          type: integer
        v:
          description: List of volume data.
          items:
            format: float
            type: number
          type: array
        p:
          description: List of price data.
          items:
            format: float
            type: number
          type: array
        y:
          description: List of yield data.
          items:
            format: float
            type: number
          type: array
        t:
          description: List of timestamp in UNIX ms.
          items:
            format: int64
            type: integer
          type: array
        si:
          description: 'List of values showing the side (Buy/sell) of each trade.
            List of supported values: <a target="_blank" href="https://docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing",>here</a>'
          items:
            type: string
          type: array
        cp:
          description: 'List of values showing the counterparty of each trade. List
            of supported values: <a target="_blank" href="https://docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing",>here</a>'
          items:
            type: string
          type: array
        rp:
          description: 'List of values showing the reporting party of each trade.
            List of supported values: <a target="_blank" href="https://docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing",>here</a>'
          items:
            type: string
          type: array
        ats:
          description: ATS flag. Y or empty
          items:
            type: string
          type: array
        c:
          description: List of trade conditions. A comprehensive list of trade conditions
            code can be found <a target="_blank" href="https://docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing">here</a>
          items:
            items:
              type: string
            type: array
          type: array
      type: object
    HistoricalNBBO:
      example:
        a:
        - 5.637377
        - 5.637377
        total: 1
        b:
        - 7.0614014
        - 7.0614014
        s: s
        c:
        - - c
          - c
        - - c
          - c
        bv:
        - 2.302136
        - 2.302136
        t:
        - 9
        - 9
        av:
        - 5.962134
        - 5.962134
        bx:
        - bx
        - bx
        ax:
        - ax
        - ax
        count: 6
        skip: 0
      properties:
        s:
          description: Symbol.
          type: string
        skip:
          description: Number of ticks skipped.
          format: int64
          type: integer
        count:
          description: Number of ticks returned. If <code>count</code> < <code>limit</code>,
            all data for that date has been returned.
          format: int64
          type: integer
        total:
          description: Total number of ticks for that date.
          format: int64
          type: integer
        av:
          description: List of Ask volume data.
          items:
            format: float
            type: number
          type: array
        a:
          description: List of Ask price data.
          items:
            format: float
            type: number
          type: array
        ax:
          description: 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>
          items:
            type: string
          type: array
        bv:
          description: List of Bid volume data.
          items:
            format: float
            type: number
          type: array
        b:
          description: List of Bid price data.
          items:
            format: float
            type: number
          type: array
        bx:
          description: 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>
          items:
            type: string
          type: array
        t:
          description: List of timestamp in UNIX ms.
          items:
            format: int64
            type: integer
          type: array
        c:
          description: 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>
          items:
            items:
              type: string
            type: array
          type: array
      type: object
    LastBid-Ask:
      example:
        a: 6.0274563
        b: 0.8008282
        bv: 1.4658129
        t: 5
        av: 5.962134
      properties:
        b:
          description: Bid price.
          format: float
          type: number
        a:
          description: Ask price.
          format: float
          type: number
        bv:
          description: Bid volume.
          format: float
          type: number
        av:
          description: Ask volume.
          format: float
          type: number
        t:
          description: Reference UNIX timestamp in ms.
          format: int64
          type: integer
      type: object
    Split:
      example:
        date: 2000-01-23
        symbol: symbol
        fromFactor: 0.8008282
        toFactor: 6.0274563
      properties:
        symbol:
          description: Symbol.
          type: string
        date:
          description: Split date.
          format: date
          type: string
        fromFactor:
          description: From factor.
          format: float
          type: number
        toFactor:
          description: To factor.
          format: float
          type: number
      type: object
    Dividends2:
      example:
        symbol: symbol
        data:
        - amount: 0.8008282
          exDate: 2000-01-23
        - amount: 0.8008282
          exDate: 2000-01-23
      properties:
        symbol:
          description: Symbol
          type: string
        data:
          description: ""
          items:
            $ref: '#/components/schemas/Dividends2Info'
          type: array
      type: object
    IndicesConstituents:
      example:
        symbol: symbol
        constituentsBreakdown:
        - symbol: symbol
          cusip: cusip
          name: name
          weight: 0.8008282
          shareClassFIGI: shareClassFIGI
          isin: isin
        - symbol: symbol
          cusip: cusip
          name: name
          weight: 0.8008282
          shareClassFIGI: shareClassFIGI
          isin: isin
        constituents:
        - constituents
        - constituents
      properties:
        symbol:
          description: Index's symbol.
          type: string
        constituents:
          description: Array of constituents.
          items:
            type: string
          type: array
        constituentsBreakdown:
          description: Array of constituents' details.
          items:
            $ref: '#/components/schemas/IndicesConstituentsBreakdown'
          type: array
      type: object
    IndicesConstituentsBreakdown:
      example:
        symbol: symbol
        cusip: cusip
        name: name
        weight: 0.8008282
        shareClassFIGI: shareClassFIGI
        isin: isin
      properties:
        symbol:
          description: Symbol.
          type: string
        name:
          description: Name.
          type: string
        isin:
          description: ISIN.
          type: string
        cusip:
          description: Cusip.
          type: string
        shareClassFIGI:
          description: Global Share Class FIGI.
          type: string
        weight:
          description: Weight.
          format: float
          type: number
      type: object
    IndexHistoricalConstituent:
      example:
        date: 2000-01-23
        symbol: symbol
        action: action
      properties:
        symbol:
          description: Symbol
          type: string
        action:
          description: <code>add</code> or <code>remove</code>.
          type: string
        date:
          description: Date of joining or leaving the index.
          format: date
          type: string
      type: object
    IndicesHistoricalConstituents:
      example:
        historicalConstituents:
        - date: 2000-01-23
          symbol: symbol
          action: action
        - date: 2000-01-23
          symbol: symbol
          action: action
        symbol: symbol
      properties:
        symbol:
          description: Index's symbol.
          type: string
        historicalConstituents:
          description: Array of historical constituents.
          items:
            $ref: '#/components/schemas/IndexHistoricalConstituent'
          type: array
      type: object
    ETFProfileData:
      example:
        nav: 6.0274563
        website: website
        cusip: cusip
        priceToEarnings: 5.962134
        isInverse: true
        avgVolume: 2.302136
        description: description
        assetClass: assetClass
        leverageFactor: 7.0614014
        dividendYield: 9.301444
        etfCompany: etfCompany
        inceptionDate: 2000-01-23
        expenseRatio: 1.4658129
        name: name
        aum: 0.8008282
        domicile: domicile
        logo: logo
        isLeveraged: true
        trackingIndex: trackingIndex
        priceToBook: 5.637377
        investmentSegment: investmentSegment
        navCurrency: navCurrency
        isin: isin
      properties:
        name:
          description: Name
          type: string
        assetClass:
          description: Asset Class.
          type: string
        investmentSegment:
          description: Investment Segment.
          type: string
        aum:
          description: AUM.
          format: float
          type: number
        nav:
          description: NAV.
          format: float
          type: number
        navCurrency:
          description: NAV currency.
          type: string
        expenseRatio:
          description: Expense ratio. For non-US funds, this is the <a href="https://www.esma.europa.eu/sites/default/files/library/2015/11/09_1028_final_kid_ongoing_charges_methodology_for_publication_u_2_.pdf"
            target="_blank">KID ongoing charges<a/>.
          format: float
          type: number
        trackingIndex:
          description: Tracking Index.
          type: string
        etfCompany:
          description: ETF issuer.
          type: string
        domicile:
          description: ETF domicile.
          type: string
        inceptionDate:
          description: Inception date.
          format: date
          type: string
        website:
          description: ETF's website.
          type: string
        logo:
          description: Logo.
          type: string
        isin:
          description: ISIN.
          type: string
        cusip:
          description: CUSIP.
          type: string
        priceToEarnings:
          description: P/E.
          format: float
          type: number
        priceToBook:
          description: P/B.
          format: float
          type: number
        avgVolume:
          description: 30-day average volume.
          format: float
          type: number
        description:
          description: ETF's description.
          type: string
        isInverse:
          description: Whether the ETF is inverse
          type: boolean
        isLeveraged:
          description: Whether the ETF is leveraged
          type: boolean
        leverageFactor:
          description: Leverage factor.
          format: float
          type: number
        dividendYield:
          description: Dividend yield.
          format: float
          type: number
      type: object
    ETFsProfile:
      example:
        symbol: symbol
        profile:
          nav: 6.0274563
          website: website
          cusip: cusip
          priceToEarnings: 5.962134
          isInverse: true
          avgVolume: 2.302136
          description: description
          assetClass: assetClass
          leverageFactor: 7.0614014
          dividendYield: 9.301444
          etfCompany: etfCompany
          inceptionDate: 2000-01-23
          expenseRatio: 1.4658129
          name: name
          aum: 0.8008282
          domicile: domicile
          logo: logo
          isLeveraged: true
          trackingIndex: trackingIndex
          priceToBook: 5.637377
          investmentSegment: investmentSegment
          navCurrency: navCurrency
          isin: isin
      properties:
        symbol:
          description: Symbol.
          type: string
        profile:
          $ref: '#/components/schemas/ETFProfileData'
      type: object
    ETFHoldingsData:
      example:
        symbol: symbol
        cusip: cusip
        name: name
        share: 6.0274563
        percent: 1.4658129
        value: 5.962134
        isin: isin
        assetType: assetType
      properties:
        symbol:
          description: Symbol description
          type: string
        name:
          description: Security name
          type: string
        isin:
          description: ISIN.
          type: string
        cusip:
          description: CUSIP.
          type: string
        share:
          description: Number of shares owned by the ETF.
          format: float
          type: number
        percent:
          description: Portfolio's percent
          format: float
          type: number
        value:
          description: Market value
          format: float
          type: number
        assetType:
          description: 'Asset type. Can be 1 of the following values: <code>Equity</code>,
            <code>ETP</code>, <code>Fund</code>, <code>Bond</code>, <code>Other</code>
            or empty.'
          type: string
      type: object
    ETFsHoldings:
      example:
        symbol: symbol
        atDate: 2000-01-23
        holdings:
        - symbol: symbol
          cusip: cusip
          name: name
          share: 6.0274563
          percent: 1.4658129
          value: 5.962134
          isin: isin
          assetType: assetType
        - symbol: symbol
          cusip: cusip
          name: name
          share: 6.0274563
          percent: 1.4658129
          value: 5.962134
          isin: isin
          assetType: assetType
        numberOfHoldings: 0
      properties:
        symbol:
          description: ETF symbol.
          type: string
        atDate:
          description: Holdings update date.
          format: date
          type: string
        numberOfHoldings:
          description: Number of holdings.
          format: int64
          type: integer
        holdings:
          description: Array of holdings.
          items:
            $ref: '#/components/schemas/ETFHoldingsData'
          type: array
      type: object
    ETFSectorExposureData:
      example:
        exposure: 0.8008282
        industry: industry
      properties:
        industry:
          description: Industry
          type: string
        exposure:
          description: Percent of exposure.
          format: float
          type: number
      type: object
    ETFsSectorExposure:
      example:
        symbol: symbol
        sectorExposure:
        - exposure: 0.8008282
          industry: industry
        - exposure: 0.8008282
          industry: industry
      properties:
        symbol:
          description: ETF symbol.
          type: string
        sectorExposure:
          description: Array of industries and exposure levels.
          items:
            $ref: '#/components/schemas/ETFSectorExposureData'
          type: array
      type: object
    ETFCountryExposureData:
      example:
        country: country
        exposure: 0.8008282
      properties:
        country:
          description: Country
          type: string
        exposure:
          description: Percent of exposure.
          format: float
          type: number
      type: object
    ETFsCountryExposure:
      example:
        symbol: symbol
        countryExposure:
        - country: country
          exposure: 0.8008282
        - country: country
          exposure: 0.8008282
      properties:
        symbol:
          description: ETF symbol.
          type: string
        countryExposure:
          description: Array of countries and and exposure levels.
          items:
            $ref: '#/components/schemas/ETFCountryExposureData'
          type: array
      type: object
    MutualFundProfileData:
      example:
        cusip: cusip
        deferredLoad: 5.962134
        description: description
        className: className
        fee12b1: 5.637377
        seriesId: seriesId
        standardMinInvestment: 3.6160767
        classId: classId
        fundCompany: fundCompany
        inceptionDate: 2000-01-23
        currency: currency
        turnover: 2.027123
        investmentSegment: investmentSegment
        beta: 1.4658129
        maxRedemptionFee: 9.301444
        sfdrClassification: sfdrClassification
        manager: manager
        iraMinInvestment: 7.0614014
        seriesName: seriesName
        totalNav: 0.8008282
        benchmark: benchmark
        frontLoad: 2.302136
        expenseRatio: 6.0274563
        name: name
        category: category
        fundFamily: fundFamily
        isin: isin
        status: status
      properties:
        name:
          description: Name
          type: string
        category:
          description: Fund's category.
          type: string
        investmentSegment:
          description: Investment Segment.
          type: string
        totalNav:
          description: NAV.
          format: float
          type: number
        expenseRatio:
          description: Expense ratio.
          format: float
          type: number
        benchmark:
          description: Index benchmark.
          type: string
        inceptionDate:
          description: Inception date.
          format: date
          type: string
        description:
          description: Fund's description.
          type: string
        fundFamily:
          description: Fund Family.
          type: string
        fundCompany:
          description: Fund Company.
          type: string
        manager:
          description: Fund's managers.
          type: string
        status:
          description: Status.
          type: string
        beta:
          description: Beta.
          format: float
          type: number
        deferredLoad:
          description: Deferred load.
          format: float
          type: number
        fee12b1:
          description: 12B-1 fee.
          format: float
          type: number
        frontLoad:
          description: Front Load.
          format: float
          type: number
        iraMinInvestment:
          description: IRA minimum investment.
          format: float
          type: number
        isin:
          description: ISIN.
          type: string
        cusip:
          description: CUSIP.
          type: string
        maxRedemptionFee:
          description: Max redemption fee.
          format: float
          type: number
        standardMinInvestment:
          description: Minimum investment for standard accounts.
          format: float
          type: number
        turnover:
          description: Turnover.
          format: float
          type: number
        seriesId:
          description: Fund's series ID. This field can be used to group multiple
            share classes into 1 unique fund.
          type: string
        seriesName:
          description: Fund's series name.
          type: string
        classId:
          description: Class ID.
          type: string
        className:
          description: Class name.
          type: string
        sfdrClassification:
          description: SFDR classification for EU funds. Under the new classifications,
            a fund's strategy will labeled under either Article 6, 8 or 9. Article
            6 covers funds which do not integrate any kind of sustainability into
            the investment process. Article 8, also known as ‘environmental and socially
            promoting’, applies “… where a financial product promotes, among other
            characteristics, environmental or social characteristics, or a combination
            of those characteristics, provided that the companies in which the investments
            are made follow good governance practices.”. Article 9, also known as
            ‘products targeting sustainable investments’, covers products targeting
            bespoke sustainable investments and applies “… where a financial product
            has sustainable investment as its objective and an index has been designated
            as a reference benchmark.”
          type: string
        currency:
          description: Fund's currency
          type: string
      type: object
    MutualFundProfile:
      example:
        symbol: symbol
        profile:
          cusip: cusip
          deferredLoad: 5.962134
          description: description
          className: className
          fee12b1: 5.637377
          seriesId: seriesId
          standardMinInvestment: 3.6160767
          classId: classId
          fundCompany: fundCompany
          inceptionDate: 2000-01-23
          currency: currency
          turnover: 2.027123
          investmentSegment: investmentSegment
          beta: 1.4658129
          maxRedemptionFee: 9.301444
          sfdrClassification: sfdrClassification
          manager: manager
          iraMinInvestment: 7.0614014
          seriesName: seriesName
          totalNav: 0.8008282
          benchmark: benchmark
          frontLoad: 2.302136
          expenseRatio: 6.0274563
          name: name
          category: category
          fundFamily: fundFamily
          isin: isin
          status: status
      properties:
        symbol:
          description: Symbol.
          type: string
        profile:
          $ref: '#/components/schemas/MutualFundProfileData'
      type: object
    MutualFundHoldingsData:
      example:
        symbol: symbol
        cusip: cusip
        name: name
        share: 6.0274563
        percent: 1.4658129
        value: 5.962134
        isin: isin
        assetType: assetType
      properties:
        symbol:
          description: Symbol description
          type: string
        name:
          description: Security name
          type: string
        isin:
          description: ISIN.
          type: string
        cusip:
          description: CUSIP.
          type: string
        share:
          description: Number of shares.
          format: float
          type: number
        percent:
          description: Portfolio's percent
          format: float
          type: number
        value:
          description: Market value
          format: float
          type: number
        assetType:
          description: 'Asset type. Can be 1 of the following values: <code>Equity</code>,
            <code>ETP</code>, <code>Fund</code>, <code>Bond</code>, <code>Other</code>
            or empty.'
          type: string
      type: object
    MutualFundHoldings:
      example:
        symbol: symbol
        atDate: 2000-01-23
        holdings:
        - symbol: symbol
          cusip: cusip
          name: name
          share: 6.0274563
          percent: 1.4658129
          value: 5.962134
          isin: isin
          assetType: assetType
        - symbol: symbol
          cusip: cusip
          name: name
          share: 6.0274563
          percent: 1.4658129
          value: 5.962134
          isin: isin
          assetType: assetType
        numberOfHoldings: 0
      properties:
        symbol:
          description: Symbol.
          type: string
        atDate:
          description: Holdings update date.
          format: date
          type: string
        numberOfHoldings:
          description: Number of holdings.
          format: int64
          type: integer
        holdings:
          description: Array of holdings.
          items:
            $ref: '#/components/schemas/MutualFundHoldingsData'
          type: array
      type: object
    MutualFundSectorExposureData:
      example:
        exposure: 0.8008282
        sector: sector
      properties:
        sector:
          description: Sector
          type: string
        exposure:
          description: Percent of exposure.
          format: float
          type: number
      type: object
    MutualFundSectorExposure:
      example:
        symbol: symbol
        sectorExposure:
        - exposure: 0.8008282
          sector: sector
        - exposure: 0.8008282
          sector: sector
      properties:
        symbol:
          description: Mutual symbol.
          type: string
        sectorExposure:
          description: Array of sector and exposure levels.
          items:
            $ref: '#/components/schemas/MutualFundSectorExposureData'
          type: array
      type: object
    MutualFundCountryExposureData:
      example:
        country: country
        exposure: 0.8008282
      properties:
        country:
          description: Country
          type: string
        exposure:
          description: Percent of exposure.
          format: float
          type: number
      type: object
    MutualFundCountryExposure:
      example:
        symbol: symbol
        countryExposure:
        - country: country
          exposure: 0.8008282
        - country: country
          exposure: 0.8008282
      properties:
        symbol:
          description: Symbol.
          type: string
        countryExposure:
          description: Array of countries and and exposure levels.
          items:
            $ref: '#/components/schemas/MutualFundCountryExposureData'
          type: array
      type: object
    MutualFundEetData:
      type: object
    MutualFundEet:
      example:
        data: '{}'
        isin: isin
      properties:
        isin:
          description: ISIN.
          type: string
        data:
          type: object
      type: object
    MutualFundEetPaiData:
      type: object
    MutualFundEetPai:
      example:
        data: '{}'
        isin: isin
      properties:
        isin:
          description: ISIN.
          type: string
        data:
          type: object
      type: object
    ForexSymbol:
      example:
        displaySymbol: displaySymbol
        symbol: symbol
        description: description
      properties:
        description:
          description: Symbol description
          type: string
        displaySymbol:
          description: Display symbol name.
          type: string
        symbol:
          description: Unique symbol used to identify this symbol used in <code>/forex/candle</code>
            endpoint.
          type: string
      type: object
    ForexCandles:
      example:
        c:
        - 5.962134
        - 5.962134
        s: s
        t:
        - 2.302136
        - 2.302136
        v:
        - 5.637377
        - 5.637377
        h:
        - 6.0274563
        - 6.0274563
        l:
        - 1.4658129
        - 1.4658129
        o:
        - 0.8008282
        - 0.8008282
      properties:
        o:
          description: List of open prices for returned candles.
          items:
            format: float
            type: number
          type: array
        h:
          description: List of high prices for returned candles.
          items:
            format: float
            type: number
          type: array
        l:
          description: List of low prices for returned candles.
          items:
            format: float
            type: number
          type: array
        c:
          description: List of close prices for returned candles.
          items:
            format: float
            type: number
          type: array
        v:
          description: List of volume data for returned candles.
          items:
            format: float
            type: number
          type: array
        t:
          description: List of timestamp for returned candles.
          items:
            format: float
            type: number
          type: array
        s:
          description: Status of the response. This field can either be ok or no_data.
          type: string
      type: object
    ForexRate:
      type: object
    Forexrates:
      example:
        quote: '{}'
        base: base
      properties:
        base:
          description: Base currency.
          type: string
        quote:
          type: object
      type: object
    CryptoSymbol:
      example:
        displaySymbol: displaySymbol
        symbol: symbol
        description: description
      properties:
        description:
          description: Symbol description
          type: string
        displaySymbol:
          description: Display symbol name.
          type: string
        symbol:
          description: Unique symbol used to identify this symbol used in <code>/crypto/candle</code>
            endpoint.
          type: string
      type: object
    CryptoProfile:
      example:
        marketCap: 0.8008282
        website: website
        totalSupply: 6.0274563
        proofType: proofType
        name: name
        description: description
        logo: logo
        maxSupply: 1.4658129
        launchDate: launchDate
        circulatingSupply: 5.962134
        longName: longName
      properties:
        longName:
          description: Long name.
          type: string
        name:
          description: Name.
          type: string
        description:
          description: Description.
          type: string
        website:
          description: Project's website.
          type: string
        marketCap:
          description: Market capitalization.
          format: float
          type: number
        totalSupply:
          description: Total supply.
          format: float
          type: number
        maxSupply:
          description: Max supply.
          format: float
          type: number
        circulatingSupply:
          description: Circulating supply.
          format: float
          type: number
        logo:
          description: Logo image.
          type: string
        launchDate:
          description: Launch date.
          type: string
        proofType:
          description: Proof type.
          type: string
      type: object
    CryptoCandles:
      example:
        c:
        - 5.962134
        - 5.962134
        s: s
        t:
        - 2
        - 2
        v:
        - 5.637377
        - 5.637377
        h:
        - 6.0274563
        - 6.0274563
        l:
        - 1.4658129
        - 1.4658129
        o:
        - 0.8008282
        - 0.8008282
      properties:
        o:
          description: List of open prices for returned candles.
          items:
            format: float
            type: number
          type: array
        h:
          description: List of high prices for returned candles.
          items:
            format: float
            type: number
          type: array
        l:
          description: List of low prices for returned candles.
          items:
            format: float
            type: number
          type: array
        c:
          description: List of close prices for returned candles.
          items:
            format: float
            type: number
          type: array
        v:
          description: List of volume data for returned candles.
          items:
            format: float
            type: number
          type: array
        t:
          description: List of timestamp for returned candles.
          items:
            format: int64
            type: integer
          type: array
        s:
          description: Status of the response. This field can either be ok or no_data.
          type: string
      type: object
    ScanPattern:
      type: object
    PatternRecognition:
      example:
        points:
        - null
        - null
      properties:
        points:
          description: Array of patterns.
          items:
            $ref: '#/components/schemas/ScanPattern'
          type: array
      type: object
    SupportResistance:
      example:
        levels:
        - 0.8008282
        - 0.8008282
      properties:
        levels:
          description: Array of support and resistance levels.
          items:
            format: float
            type: number
          type: array
      type: object
    Indicator:
      example:
        buy: 0
        sell: 1
        neutral: 6
      properties:
        buy:
          description: Number of buy signals
          format: int64
          type: integer
        neutral:
          description: Number of neutral signals
          format: int64
          type: integer
        sell:
          description: Number of sell signals
          format: int64
          type: integer
      type: object
    TechnicalAnalysis:
      example:
        count:
          buy: 0
          sell: 1
          neutral: 6
        signal: signal
      properties:
        count:
          $ref: '#/components/schemas/Indicator'
        signal:
          description: Aggregate Signal
          type: string
      type: object
    Trend:
      example:
        trending: true
        adx: 5.962134
      properties:
        adx:
          description: ADX reading
          format: float
          type: number
        trending:
          description: Whether market is trending or going sideway
          type: boolean
      type: object
    AggregateIndicators:
      example:
        trend:
          trending: true
          adx: 5.962134
        technicalAnalysis:
          count:
            buy: 0
            sell: 1
            neutral: 6
          signal: signal
      properties:
        technicalAnalysis:
          $ref: '#/components/schemas/TechnicalAnalysis'
        trend:
          $ref: '#/components/schemas/Trend'
      type: object
    TechnicalIndicator:
      type: object
    IndicatorFields:
      type: object
    StockTranscripts:
      example:
        year: 0
        id: id
        time: time
        title: title
        quarter: 6
      properties:
        id:
          description: Transcript's ID used to get the <a href="#transcripts">full
            transcript</a>.
          type: string
        title:
          description: Title.
          type: string
        time:
          description: Time of the event.
          type: string
        year:
          description: Year of earnings result in the case of earnings call transcript.
          format: int64
          type: integer
        quarter:
          description: Quarter of earnings result in the case of earnings call transcript.
          format: int64
          type: integer
      type: object
    EarningsCallTranscriptsList:
      example:
        symbol: symbol
        transcripts:
        - year: 0
          id: id
          time: time
          title: title
          quarter: 6
        - year: 0
          id: id
          time: time
          title: title
          quarter: 6
      properties:
        symbol:
          description: Company symbol.
          type: string
        transcripts:
          description: Array of transcripts' metadata
          items:
            $ref: '#/components/schemas/StockTranscripts'
          type: array
      type: object
    TranscriptContent:
      example:
        speech:
        - speech
        - speech
        session: session
        name: name
      properties:
        name:
          description: Speaker's name
          type: string
        speech:
          description: Speaker's speech
          items:
            type: string
          type: array
        session:
          description: Earnings calls section (management discussion or Q&A)
          type: string
      type: object
    TranscriptParticipant:
      example:
        role: role
        name: name
        description: description
      properties:
        name:
          description: Participant's name
          type: string
        description:
          description: Participant's description
          type: string
        role:
          description: Whether the speak is a company's executive or an analyst
          type: string
      type: object
    EarningsCallTranscripts:
      example:
        symbol: symbol
        transcript:
        - speech:
          - speech
          - speech
          session: session
          name: name
        - speech:
          - speech
          - speech
          session: session
          name: name
        year: 0
        audio: audio
        id: id
        time: time
        title: title
        participant:
        - role: role
          name: name
          description: description
        - role: role
          name: name
          description: description
        quarter: 6
      properties:
        symbol:
          description: Company symbol.
          type: string
        transcript:
          description: Transcript content.
          items:
            $ref: '#/components/schemas/TranscriptContent'
          type: array
        participant:
          description: Participant list
          items:
            $ref: '#/components/schemas/TranscriptParticipant'
          type: array
        audio:
          description: Audio link.
          type: string
        id:
          description: Transcript's ID.
          type: string
        title:
          description: Title.
          type: string
        time:
          description: Time of the event.
          type: string
        year:
          description: Year of earnings result in the case of earnings call transcript.
          format: int64
          type: integer
        quarter:
          description: Quarter of earnings result in the case of earnings call transcript.
          format: int64
          type: integer
      type: object
    PresentationData:
      example:
        atTime: atTime
        year: 6
        title: title
        url: url
        quarter: 0
      properties:
        quarter:
          description: Quarter
          format: int64
          type: integer
        year:
          description: Year
          format: int64
          type: integer
        url:
          description: Presentation url
          type: string
        title:
          description: Title
          type: string
        atTime:
          description: At Time.
          type: string
      type: object
    StockPresentation:
      example:
        symbol: symbol
        res:
        - atTime: atTime
          year: 6
          title: title
          url: url
          quarter: 0
        - atTime: atTime
          year: 6
          title: title
          url: url
          quarter: 0
      properties:
        symbol:
          description: Company symbol.
          type: string
        res:
          description: Presentation data.
          items:
            $ref: '#/components/schemas/PresentationData'
          type: array
      type: object
    SentimentContent:
      example:
        positiveMention: 6
        atTime: atTime
        score: 2.302136
        positiveScore: 5.962134
        negativeMention: 1
        negativeScore: 5.637377
        mention: 0
      properties:
        mention:
          description: Number of mentions
          format: int64
          type: integer
        positiveMention:
          description: Number of positive mentions
          format: int64
          type: integer
        negativeMention:
          description: Number of negative mentions
          format: int64
          type: integer
        positiveScore:
          description: Positive score. Range 0-1
          format: float
          type: number
        negativeScore:
          description: Negative score. Range 0-1
          format: float
          type: number
        score:
          description: 'Final score. Range: -1 to 1 with 1 is very positive and -1
            is very negative'
          format: float
          type: number
        atTime:
          description: Period.
          type: string
      type: object
    SocialSentiment:
      example:
        symbol: symbol
        data:
        - positiveMention: 6
          atTime: atTime
          score: 2.302136
          positiveScore: 5.962134
          negativeMention: 1
          negativeScore: 5.637377
          mention: 0
        - positiveMention: 6
          atTime: atTime
          score: 2.302136
          positiveScore: 5.962134
          negativeMention: 1
          negativeScore: 5.637377
          mention: 0
      properties:
        symbol:
          description: Company symbol.
          type: string
        data:
          description: Sentiment data.
          items:
            $ref: '#/components/schemas/SentimentContent'
          type: array
      type: object
    InvestmentThemePortfolio:
      example:
        symbol: symbol
      properties:
        symbol:
          description: Symbol
          type: string
      type: object
    InvestmentThemes:
      example:
        data:
        - symbol: symbol
        - symbol: symbol
        theme: theme
      properties:
        theme:
          description: Investment theme
          type: string
        data:
          description: Investment theme portfolio.
          items:
            $ref: '#/components/schemas/InvestmentThemePortfolio'
          type: array
      type: object
    SectorMetric:
      example:
        data:
        - metrics: '{}'
          sector: sector
        - metrics: '{}'
          sector: sector
        region: region
      properties:
        region:
          description: Region.
          type: string
        data:
          description: Metrics for each sector.
          items:
            $ref: '#/components/schemas/SectorMetricData'
          type: array
      type: object
    SectorMetricData:
      example:
        metrics: '{}'
        sector: sector
      properties:
        sector:
          description: Sector
          type: string
        metrics:
          description: Metrics data in key-value format. <code>a</code> and <code>m</code>
            fields are for average and median respectively.
          properties: {}
          type: object
      type: object
    KeyCustomersSuppliers:
      example:
        twoYearCorrelation: 2.302136
        symbol: symbol
        country: country
        twoWeekCorrelation: 5.637377
        oneMonthCorrelation: 0.8008282
        supplier: true
        name: name
        industry: industry
        threeMonthCorrelation: 5.962134
        oneYearCorrelation: 6.0274563
        sixMonthCorrelation: 1.4658129
        customer: true
      properties:
        symbol:
          description: Symbol
          type: string
        name:
          description: Name
          type: string
        country:
          description: Country
          type: string
        industry:
          description: Industry
          type: string
        customer:
          description: Whether the company is a customer.
          type: boolean
        supplier:
          description: Whether the company is a supplier
          type: boolean
        oneMonthCorrelation:
          description: 1-month price correlation
          format: float
          type: number
        oneYearCorrelation:
          description: 1-year price correlation
          format: float
          type: number
        sixMonthCorrelation:
          description: 6-month price correlation
          format: float
          type: number
        threeMonthCorrelation:
          description: 3-month price correlation
          format: float
          type: number
        twoWeekCorrelation:
          description: 2-week price correlation
          format: float
          type: number
        twoYearCorrelation:
          description: 2-year price correlation
          format: float
          type: number
      type: object
    SupplyChainRelationships:
      example:
        symbol: symbol
        data:
        - twoYearCorrelation: 2.302136
          symbol: symbol
          country: country
          twoWeekCorrelation: 5.637377
          oneMonthCorrelation: 0.8008282
          supplier: true
          name: name
          industry: industry
          threeMonthCorrelation: 5.962134
          oneYearCorrelation: 6.0274563
          sixMonthCorrelation: 1.4658129
          customer: true
        - twoYearCorrelation: 2.302136
          symbol: symbol
          country: country
          twoWeekCorrelation: 5.637377
          oneMonthCorrelation: 0.8008282
          supplier: true
          name: name
          industry: industry
          threeMonthCorrelation: 5.962134
          oneYearCorrelation: 6.0274563
          sixMonthCorrelation: 1.4658129
          customer: true
      properties:
        symbol:
          description: symbol
          type: string
        data:
          description: Key customers and suppliers.
          items:
            $ref: '#/components/schemas/KeyCustomersSuppliers'
          type: array
      type: object
    HistoricalCompanyESG:
      example:
        symbol: symbol
        data:
        - period: period
          data: '{}'
          totalESGScore: 0.8008282
          environmentScore: 6.0274563
          governanceScore: 1.4658129
          socialScore: 5.962134
        - period: period
          data: '{}'
          totalESGScore: 0.8008282
          environmentScore: 6.0274563
          governanceScore: 1.4658129
          socialScore: 5.962134
      properties:
        symbol:
          description: symbol
          type: string
        data:
          description: Historical ESG data points.
          items:
            $ref: '#/components/schemas/CompanyESG2'
          type: array
      type: object
    CompanyESG2:
      example:
        period: period
        data: '{}'
        totalESGScore: 0.8008282
        environmentScore: 6.0274563
        governanceScore: 1.4658129
        socialScore: 5.962134
      properties:
        totalESGScore:
          description: Total ESG Score
          format: float
          type: number
        environmentScore:
          description: Environment Score
          format: float
          type: number
        governanceScore:
          description: Governance Score
          format: float
          type: number
        socialScore:
          description: Social Score
          format: float
          type: number
        data:
          type: object
        period:
          description: Period
          type: string
      type: object
    CompanyESG:
      example:
        symbol: symbol
        data: '{}'
        totalESGScore: 0.8008282
        environmentScore: 6.0274563
        governanceScore: 1.4658129
        socialScore: 5.962134
      properties:
        symbol:
          description: symbol
          type: string
        totalESGScore:
          description: Total ESG Score
          format: float
          type: number
        environmentScore:
          description: Environment Score
          format: float
          type: number
        governanceScore:
          description: Governance Score
          format: float
          type: number
        socialScore:
          description: Social Score
          format: float
          type: number
        data:
          type: object
      type: object
    CompanyESGMap:
      type: object
    CompanyEarningsQualityScore:
      example:
        symbol: symbol
        data:
        - profitability: 6.0274563
          leverage: 5.962134
          score: 5.637377
          letterScore: letterScore
          period: period
          cashGenerationCapitalAllocation: 1.4658129
          growth: 0.8008282
        - profitability: 6.0274563
          leverage: 5.962134
          score: 5.637377
          letterScore: letterScore
          period: period
          cashGenerationCapitalAllocation: 1.4658129
          growth: 0.8008282
        freq: freq
      properties:
        symbol:
          description: Symbol
          type: string
        freq:
          description: Frequency
          type: string
        data:
          description: Array of earnings quality score.
          items:
            $ref: '#/components/schemas/CompanyEarningsQualityScoreData'
          type: array
      type: object
    CompanyEarningsQualityScoreData:
      example:
        profitability: 6.0274563
        leverage: 5.962134
        score: 5.637377
        letterScore: letterScore
        period: period
        cashGenerationCapitalAllocation: 1.4658129
        growth: 0.8008282
      properties:
        period:
          description: Period
          type: string
        growth:
          description: Growth Score
          format: float
          type: number
        profitability:
          description: Profitability Score
          format: float
          type: number
        cashGenerationCapitalAllocation:
          description: Cash Generation and Capital Allocation
          format: float
          type: number
        leverage:
          description: Leverage Score
          format: float
          type: number
        score:
          description: Total Score
          format: float
          type: number
        letterScore:
          description: Letter Score
          type: string
      type: object
    CovidInfo:
      example:
        death: 6.0274563
        state: state
        updated: updated
        case: 0.8008282
      properties:
        state:
          description: State.
          type: string
        case:
          description: Number of confirmed cases.
          format: float
          type: number
        death:
          description: Number of confirmed deaths.
          format: float
          type: number
        updated:
          description: Updated time.
          type: string
      type: object
    FDAComitteeMeeting:
      example:
        fromDate: fromDate
        toDate: toDate
        eventDescription: eventDescription
        url: url
      properties:
        fromDate:
          description: Start time of the event in EST.
          type: string
        toDate:
          description: End time of the event in EST.
          type: string
        eventDescription:
          description: Event's description.
          type: string
        url:
          description: URL.
          type: string
      type: object
    CountryMetadata:
      example:
        country: country
        code3: code3
        code2: code2
        subRegion: subRegion
        codeNo: codeNo
        equityRiskPremium: 1.4658129
        defaultSpread: 0.8008282
        rating: rating
        currency: currency
        region: region
        currencyCode: currencyCode
        countryRiskPremium: 6.0274563
      properties:
        country:
          description: Country name
          type: string
        code2:
          description: Alpha 2 code
          type: string
        code3:
          description: Alpha 3 code
          type: string
        codeNo:
          description: UN code
          type: string
        currency:
          description: Currency name
          type: string
        currencyCode:
          description: Currency code
          type: string
        region:
          description: Region
          type: string
        subRegion:
          description: Sub-Region
          type: string
        rating:
          description: Moody's credit risk rating.
          type: string
        defaultSpread:
          description: Default spread
          format: float
          type: number
        countryRiskPremium:
          description: Country risk premium
          format: float
          type: number
        equityRiskPremium:
          description: Equity risk premium
          format: float
          type: number
      type: object
    Economic event:
      example:
        actual: 0.8008282
        country: country
        unit: unit
        prev: 6.0274563
        impact: impact
        estimate: 1.4658129
        time: time
        event: event
      properties:
        actual:
          description: Actual release
          format: float
          type: number
        prev:
          description: Previous release
          format: float
          type: number
        country:
          description: Country
          type: string
        unit:
          description: Unit
          type: string
        estimate:
          description: Estimate
          format: float
          type: number
        event:
          description: Event
          type: string
        impact:
          description: Impact level
          type: string
        time:
          description: Release time
          type: string
      type: object
    EconomicCalendar:
      example:
        economicCalendar:
        - actual: 0.8008282
          country: country
          unit: unit
          prev: 6.0274563
          impact: impact
          estimate: 1.4658129
          time: time
          event: event
        - actual: 0.8008282
          country: country
          unit: unit
          prev: 6.0274563
          impact: impact
          estimate: 1.4658129
          time: time
          event: event
      properties:
        economicCalendar:
          description: Array of economic events.
          items:
            $ref: '#/components/schemas/Economic event'
          type: array
      type: object
    EconomicCode:
      example:
        country: country
        unit: unit
        code: code
        name: name
      properties:
        code:
          description: Finnhub economic code used to get historical data
          type: string
        country:
          description: Country
          type: string
        name:
          description: Indicator name
          type: string
        unit:
          description: Unit
          type: string
      type: object
    EconomicDataInfo:
      example:
        date: date
        value: 0.8008282
      properties:
        date:
          description: Date of the reading
          type: string
        value:
          description: Value
          format: float
          type: number
      type: object
    EconomicData:
      example:
        code: code
        data:
        - date: date
          value: 0.8008282
        - date: date
          value: 0.8008282
      properties:
        data:
          description: Array of economic data for requested code.
          items:
            $ref: '#/components/schemas/EconomicDataInfo'
          type: array
        code:
          description: Finnhub economic code
          type: string
      type: object
    MarketCapData:
      example:
        marketCapitalization: 0.8008282
        atDate: atDate
      properties:
        atDate:
          description: Date of the reading
          type: string
        marketCapitalization:
          description: Value
          format: float
          type: number
      type: object
    HistoricalMarketCapData:
      example:
        symbol: symbol
        data:
        - marketCapitalization: 0.8008282
          atDate: atDate
        - marketCapitalization: 0.8008282
          atDate: atDate
        currency: currency
      properties:
        data:
          description: Array of market data.
          items:
            $ref: '#/components/schemas/MarketCapData'
          type: array
        symbol:
          description: Symbol
          type: string
        currency:
          description: Currency
          type: string
      type: object
    EmployeeCount:
      example:
        atDate: atDate
        employee: 0.8008282
      properties:
        atDate:
          description: Date of the reading
          type: string
        employee:
          description: Value
          format: float
          type: number
      type: object
    HistoricalEmployeeCount:
      example:
        symbol: symbol
        data:
        - atDate: atDate
          employee: 0.8008282
        - atDate: atDate
          employee: 0.8008282
      properties:
        data:
          description: Array of market data.
          items:
            $ref: '#/components/schemas/EmployeeCount'
          type: array
        symbol:
          description: Symbol
          type: string
      type: object
    AirlinePriceIndex:
      example:
        date: date
        priceIndex: 0.8008282
        dailyAvgPrice: 6.0274563
      properties:
        date:
          description: Date
          type: string
        priceIndex:
          description: Price Index
          format: float
          type: number
        dailyAvgPrice:
          description: Daily average ticket price.
          format: float
          type: number
      type: object
    AirlinePriceIndexData:
      example:
        data:
        - date: date
          priceIndex: 0.8008282
          dailyAvgPrice: 6.0274563
        - date: date
          priceIndex: 0.8008282
          dailyAvgPrice: 6.0274563
        from: from
        to: to
        airline: airline
      properties:
        data:
          description: Array of price index.
          items:
            $ref: '#/components/schemas/AirlinePriceIndex'
          type: array
        airline:
          description: Airline name
          type: string
        from:
          description: From date
          type: string
        to:
          description: To date
          type: string
      type: object
    BankBranchRes:
      example:
        symbol: symbol
        data:
        - date: date
          branchId: branchId
          zipCode: zipCode
          address: address
          state: state
        - date: date
          branchId: branchId
          zipCode: zipCode
          address: address
          state: state
      properties:
        data:
          description: Array of branches.
          items:
            $ref: '#/components/schemas/BankBranchData'
          type: array
        symbol:
          description: Symbol
          type: string
      type: object
    BankBranchData:
      example:
        date: date
        branchId: branchId
        zipCode: zipCode
        address: address
        state: state
      properties:
        branchId:
          description: Branch ID
          type: string
        address:
          description: Branch address
          type: string
        state:
          description: State
          type: string
        zipCode:
          description: ' Zip code'
          type: string
        date:
          description: Date opened
          type: string
      type: object
    BondYieldCurveInfo:
      example:
        d: d
        v: 0.8008282
      properties:
        d:
          description: Date of the reading
          type: string
        v:
          description: Value
          format: float
          type: number
      type: object
    BondYieldCurve:
      example:
        code: code
        data:
        - d: d
          v: 0.8008282
        - d: d
          v: 0.8008282
      properties:
        data:
          description: Array of data.
          items:
            $ref: '#/components/schemas/BondYieldCurveInfo'
          type: array
        code:
          description: Bond's code
          type: string
      type: object
    UsptoPatentResult:
      example:
        symbol: symbol
        data:
        - companyFilingName:
          - companyFilingName
          - companyFilingName
          filingStatus: filingStatus
          applicationNumber: applicationNumber
          filingDate: filingDate
          patentNumber: patentNumber
          description: description
          publicationDate: publicationDate
          url: url
          patentType: patentType
        - companyFilingName:
          - companyFilingName
          - companyFilingName
          filingStatus: filingStatus
          applicationNumber: applicationNumber
          filingDate: filingDate
          patentNumber: patentNumber
          description: description
          publicationDate: publicationDate
          url: url
          patentType: patentType
      properties:
        symbol:
          description: Symbol.
          type: string
        data:
          description: Array of patents.
          items:
            $ref: '#/components/schemas/UsptoPatent'
          type: array
      type: object
    UsptoPatent:
      example:
        companyFilingName:
        - companyFilingName
        - companyFilingName
        filingStatus: filingStatus
        applicationNumber: applicationNumber
        filingDate: filingDate
        patentNumber: patentNumber
        description: description
        publicationDate: publicationDate
        url: url
        patentType: patentType
      properties:
        applicationNumber:
          description: Application Number.
          type: string
        companyFilingName:
          description: Array of companies' name on the patent.
          items:
            type: string
          type: array
        filingDate:
          description: Filing date.
          type: string
        description:
          description: Description.
          type: string
        filingStatus:
          description: Filing status.
          type: string
        patentNumber:
          description: Patent number.
          type: string
        publicationDate:
          description: Publication date.
          type: string
        patentType:
          description: Patent's type.
          type: string
        url:
          description: URL of the original article.
          type: string
      type: object
    VisaApplicationResult:
      example:
        symbol: symbol
        data:
        - worksiteCity: worksiteCity
          symbol: symbol
          fullTimePosition: fullTimePosition
          year: 0
          endDate: endDate
          h1bDependent: h1bDependent
          caseStatus: caseStatus
          jobTitle: jobTitle
          wageLevel: wageLevel
          employerName: employerName
          wageRangeFrom: 1.4658129
          visaClass: visaClass
          worksiteCounty: worksiteCounty
          beginDate: beginDate
          wageRangeTo: 5.962134
          caseNumber: caseNumber
          worksiteAddress: worksiteAddress
          worksitePostalCode: worksitePostalCode
          receivedDate: receivedDate
          socCode: socCode
          wageUnitOfPay: wageUnitOfPay
          quarter: 6
          worksiteState: worksiteState
        - worksiteCity: worksiteCity
          symbol: symbol
          fullTimePosition: fullTimePosition
          year: 0
          endDate: endDate
          h1bDependent: h1bDependent
          caseStatus: caseStatus
          jobTitle: jobTitle
          wageLevel: wageLevel
          employerName: employerName
          wageRangeFrom: 1.4658129
          visaClass: visaClass
          worksiteCounty: worksiteCounty
          beginDate: beginDate
          wageRangeTo: 5.962134
          caseNumber: caseNumber
          worksiteAddress: worksiteAddress
          worksitePostalCode: worksitePostalCode
          receivedDate: receivedDate
          socCode: socCode
          wageUnitOfPay: wageUnitOfPay
          quarter: 6
          worksiteState: worksiteState
      properties:
        symbol:
          description: Symbol.
          type: string
        data:
          description: Array of H1b and Permanent visa applications.
          items:
            $ref: '#/components/schemas/VisaApplication'
          type: array
      type: object
    LobbyingResult:
      example:
        symbol: symbol
        data:
        - income: 6.0274563
          date: date
          symbol: symbol
          country: country
          period: period
          clientId: clientId
          year: 0
          documentUrl: documentUrl
          registrantId: registrantId
          description: description
          postedName: postedName
          senateId: senateId
          name: name
          houseregistrantId: houseregistrantId
          expenses: 1.4658129
        - income: 6.0274563
          date: date
          symbol: symbol
          country: country
          period: period
          clientId: clientId
          year: 0
          documentUrl: documentUrl
          registrantId: registrantId
          description: description
          postedName: postedName
          senateId: senateId
          name: name
          houseregistrantId: houseregistrantId
          expenses: 1.4658129
      properties:
        symbol:
          description: Symbol.
          type: string
        data:
          description: Array of lobbying activities.
          items:
            $ref: '#/components/schemas/LobbyingData'
          type: array
      type: object
    UsaSpendingResult:
      example:
        symbol: symbol
        data:
        - totalValue: 0.8008282
          symbol: symbol
          country: country
          awardingOfficeName: awardingOfficeName
          performanceCity: performanceCity
          recipientParentName: recipientParentName
          performanceCongressionalDistrict: performanceCongressionalDistrict
          performanceCounty: performanceCounty
          performanceStartDate: performanceStartDate
          awardingAgencyName: awardingAgencyName
          performanceCountry: performanceCountry
          performanceZipCode: performanceZipCode
          awardDescription: awardDescription
          performanceState: performanceState
          recipientName: recipientName
          awardingSubAgencyName: awardingSubAgencyName
          permalink: permalink
          actionDate: actionDate
          performanceEndDate: performanceEndDate
          naicsCode: naicsCode
        - totalValue: 0.8008282
          symbol: symbol
          country: country
          awardingOfficeName: awardingOfficeName
          performanceCity: performanceCity
          recipientParentName: recipientParentName
          performanceCongressionalDistrict: performanceCongressionalDistrict
          performanceCounty: performanceCounty
          performanceStartDate: performanceStartDate
          awardingAgencyName: awardingAgencyName
          performanceCountry: performanceCountry
          performanceZipCode: performanceZipCode
          awardDescription: awardDescription
          performanceState: performanceState
          recipientName: recipientName
          awardingSubAgencyName: awardingSubAgencyName
          permalink: permalink
          actionDate: actionDate
          performanceEndDate: performanceEndDate
          naicsCode: naicsCode
      properties:
        symbol:
          description: Symbol.
          type: string
        data:
          description: Array of government's spending data points.
          items:
            $ref: '#/components/schemas/UsaSpending'
          type: array
      type: object
    UsaSpending:
      example:
        totalValue: 0.8008282
        symbol: symbol
        country: country
        awardingOfficeName: awardingOfficeName
        performanceCity: performanceCity
        recipientParentName: recipientParentName
        performanceCongressionalDistrict: performanceCongressionalDistrict
        performanceCounty: performanceCounty
        performanceStartDate: performanceStartDate
        awardingAgencyName: awardingAgencyName
        performanceCountry: performanceCountry
        performanceZipCode: performanceZipCode
        awardDescription: awardDescription
        performanceState: performanceState
        recipientName: recipientName
        awardingSubAgencyName: awardingSubAgencyName
        permalink: permalink
        actionDate: actionDate
        performanceEndDate: performanceEndDate
        naicsCode: naicsCode
      properties:
        symbol:
          description: Symbol.
          type: string
        recipientName:
          description: Company's name.
          type: string
        recipientParentName:
          description: Company's name.
          type: string
        awardDescription:
          description: Description.
          type: string
        country:
          description: Recipient's country.
          type: string
        actionDate:
          description: Period.
          type: string
        totalValue:
          description: Income reported by lobbying firms.
          format: float
          type: number
        performanceStartDate:
          description: Performance start date.
          type: string
        performanceEndDate:
          description: Performance end date.
          type: string
        awardingAgencyName:
          description: Award agency.
          type: string
        awardingSubAgencyName:
          description: Award sub-agency.
          type: string
        awardingOfficeName:
          description: Award office name.
          type: string
        performanceCountry:
          description: Performance country.
          type: string
        performanceCity:
          description: Performance city.
          type: string
        performanceCounty:
          description: Performance county.
          type: string
        performanceState:
          description: Performance state.
          type: string
        performanceZipCode:
          description: Performance zip code.
          type: string
        performanceCongressionalDistrict:
          description: Performance congressional district.
          type: string
        naicsCode:
          description: NAICS code.
          type: string
        permalink:
          description: Permalink.
          type: string
      type: object
    LobbyingData:
      example:
        income: 6.0274563
        date: date
        symbol: symbol
        country: country
        period: period
        clientId: clientId
        year: 0
        documentUrl: documentUrl
        registrantId: registrantId
        description: description
        postedName: postedName
        senateId: senateId
        name: name
        houseregistrantId: houseregistrantId
        expenses: 1.4658129
      properties:
        symbol:
          description: Symbol.
          type: string
        name:
          description: Company's name.
          type: string
        description:
          description: Description.
          type: string
        country:
          description: Country.
          type: string
        year:
          description: Year.
          format: int64
          type: integer
        period:
          description: Period.
          type: string
        income:
          description: Income reported by lobbying firms.
          format: float
          type: number
        expenses:
          description: Expenses reported by the company.
          format: float
          type: number
        documentUrl:
          description: Document's URL.
          type: string
        postedName:
          description: Posted name.
          type: string
        date:
          description: Date.
          type: string
        clientId:
          description: Client ID.
          type: string
        registrantId:
          description: Registrant ID.
          type: string
        senateId:
          description: Senate ID.
          type: string
        houseregistrantId:
          description: House registrant ID.
          type: string
      type: object
    BondProfile:
      example:
        cusip: cusip
        callable: true
        coupon: 0.8008282
        amountOutstanding: 5.962134
        figi: figi
        paymentFrequency: paymentFrequency
        assetType: assetType
        firstCouponDate: firstCouponDate
        securityLevel: securityLevel
        offeringPrice: 6.0274563
        industrySubGroup: industrySubGroup
        originalOffering: 1.4658129
        maturityDate: maturityDate
        couponType: couponType
        bondType: bondType
        issueDate: issueDate
        asset: asset
        debtType: debtType
        isin: isin
        industryGroup: industryGroup
        datedDate: datedDate
      properties:
        isin:
          description: ISIN.
          type: string
        cusip:
          description: Cusip.
          type: string
        figi:
          description: FIGI.
          type: string
        coupon:
          description: Coupon.
          format: float
          type: number
        maturityDate:
          description: Period.
          type: string
        offeringPrice:
          description: Offering price.
          format: float
          type: number
        issueDate:
          description: Issue date.
          type: string
        bondType:
          description: Bond type.
          type: string
        debtType:
          description: Bond type.
          type: string
        industryGroup:
          description: Industry.
          type: string
        industrySubGroup:
          description: Sub-Industry.
          type: string
        asset:
          description: Asset.
          type: string
        assetType:
          description: Asset.
          type: string
        datedDate:
          description: Dated date.
          type: string
        firstCouponDate:
          description: First coupon date.
          type: string
        originalOffering:
          description: Offering amount.
          format: float
          type: number
        amountOutstanding:
          description: Outstanding amount.
          format: float
          type: number
        paymentFrequency:
          description: Payment frequency.
          type: string
        securityLevel:
          description: Security level.
          type: string
        callable:
          description: Callable.
          type: boolean
        couponType:
          description: Coupon type.
          type: string
      type: object
    BondCandles:
      example:
        c:
        - 0.8008282
        - 0.8008282
        s: s
        t:
        - 6
        - 6
      properties:
        c:
          description: List of close prices for returned candles.
          items:
            format: float
            type: number
          type: array
        t:
          description: List of timestamp for returned candles.
          items:
            format: int64
            type: integer
          type: array
        s:
          description: Status of the response. This field can either be ok or no_data.
          type: string
      type: object
    VisaApplication:
      example:
        worksiteCity: worksiteCity
        symbol: symbol
        fullTimePosition: fullTimePosition
        year: 0
        endDate: endDate
        h1bDependent: h1bDependent
        caseStatus: caseStatus
        jobTitle: jobTitle
        wageLevel: wageLevel
        employerName: employerName
        wageRangeFrom: 1.4658129
        visaClass: visaClass
        worksiteCounty: worksiteCounty
        beginDate: beginDate
        wageRangeTo: 5.962134
        caseNumber: caseNumber
        worksiteAddress: worksiteAddress
        worksitePostalCode: worksitePostalCode
        receivedDate: receivedDate
        socCode: socCode
        wageUnitOfPay: wageUnitOfPay
        quarter: 6
        worksiteState: worksiteState
      properties:
        year:
          description: Year.
          format: int64
          type: integer
        quarter:
          description: Quarter.
          format: int64
          type: integer
        symbol:
          description: Symbol.
          type: string
        caseNumber:
          description: Case number.
          type: string
        caseStatus:
          description: Case status.
          type: string
        receivedDate:
          description: Received date.
          type: string
        visaClass:
          description: Visa class.
          type: string
        jobTitle:
          description: Job Title.
          type: string
        socCode:
          description: SOC Code. A list of SOC code can be found <a href="https://www.bls.gov/oes/current/oes_stru.htm"
            target="_blank">here</a>.
          type: string
        fullTimePosition:
          description: Full-time position flag.
          type: string
        beginDate:
          description: Job's start date.
          type: string
        endDate:
          description: Job's end date.
          type: string
        employerName:
          description: Company's name.
          type: string
        worksiteAddress:
          description: Worksite address.
          type: string
        worksiteCity:
          description: Worksite city.
          type: string
        worksiteCounty:
          description: Worksite county.
          type: string
        worksiteState:
          description: Worksite state.
          type: string
        worksitePostalCode:
          description: Worksite postal code.
          type: string
        wageRangeFrom:
          description: Wage range from.
          format: float
          type: number
        wageRangeTo:
          description: Wage range to.
          format: float
          type: number
        wageUnitOfPay:
          description: Wage unit of pay.
          type: string
        wageLevel:
          description: Wage level.
          type: string
        h1bDependent:
          description: H1B dependent flag.
          type: string
      type: object
  securitySchemes:
    api_key:
      in: query
      name: token
      type: apiKey
x-original-swagger-version: "2.0"