Boolio Quant AI · GPT アクション

openapi: 3.1.0
info:
  title: Boolio AI Analyst
  version: "0.1"
servers:
  - url: https://api.chat.boolio.ai
paths:
  /cosmos/list-all-fs-items:
    post:
      description: List All the Financial Item Number (FSItem) for a given factor or indicator. This endpoint provides
        financial item numbers and their corresponding content.
      operationId: ListAllFSItems
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ListAllFSItems"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/list-all-eco-items:
    post:
      description: List All the economic indicator codes.
      operationId: ListAllEcoItems
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ListAllEcoItems"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/list-all-industry-codes:
    post:
      description: List All industry codes.
      operationId: ListAllIndustryCodes
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ListAllIndustryItems"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/list-all-investor-ids:
    post:
      description: List All famous investors by name.
      operationId: ListAllInvestorIds
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ListAllInvestorIds"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/analyze-stock-by-topic:
    post:
      description: Provide detailed stock analysis based on a specific topic
      operationId: AnalyzeStockByTopic
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AnalyzeStockByTopic"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/stock-features:
    post:
      description: Analyze Key Features of a Stock for Informed Investment Decisions. The available features are
        Profitability, Growth, Undervalued, Momentum, FinancialStability, Sentiment, and ShareholderReturn.
      operationId: StockFeatures
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/StockFeatures"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/company-historical-financial-data-by-fs-items:
    post:
      description: Get historical financial data for multiple FSItems of a company
      operationId: CompanyHistoricalFinancialDataByFSItems
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/HistoricalFindata"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/stock-historical-price:
    post:
      description: Get stock prices from the start date
      operationId: StockHistoricalPrice
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/HistoricalPrice"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/get-multiple-stocks-current-finance-data-by-f-sitems:
    post:
      description: >+
        An API that retrieves recent financial data series for user-specified stocks.The tickers and regions are used to
        distinguish stocks as a pair. The ticker and region code are separated by an '_'.


      operationId: GetMultipleStocksCurrentFinanceDataByFSitems
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetMultipleStocksCurrentFinanceDataByFSitems"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/get-portfolio-analysis:
    post:
      description: >
        An API that provides portfolio characteristic analysis for user-specified stocks.


        This endpoint evaluates portfolios based on user-specified stocks, regions, and weights. It includes factor analysis against the S&P 500 benchmark and a BoolioScore on a 100-point scale to assess portfolio strength.
      operationId: GetPortfolioAnalysis
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetPortfolioAnalysis"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/get-multiple-stocks-price-time-series-from-start-date-to-today:
    post:
      description: Retrieve historical stock prices for specified stocks using tickers and regions. For example, "005930_AAPL"
        for Samsung Electronics and Apple in regions "KR_US", starting from a user-specified date.
      operationId: GetMultipleStocksPriceTimeSeriesFromStartDateToToday
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetMultipleStocksPriceTimeSeriesFromStartDateToToday"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/get-top-stocks-in-region-based-on-topics:
    post:
      description: >
        Retrieves the top (num_stocks) stocks in a specific region based on a specified topic.


        This endpoint fetches the top (num_stocks) stocks in a specified region, ranked according to a specified topic. if question about bottom (num_stocks) stocks, set sign = -1.
      operationId: GetTopStocksInRegionBasedOnTopics
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetTopStocksInRegionBasedOnTopics"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/get-high-or-low-correlated-stocks-with-economic-indicators-by-eco-item:
    post:
      description: Retrieves 'num_stocks' stocks with the highest or lowest correlation to a given economic indicator from a
        specified country(region). Gathers stock data and returns a list based on correlation.
      operationId: GetHighOrLowCorrelatedStocksWithEconomicIndicatorsByEcoItem
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetHighOrLowCorrelatedStocksWithEconomicIndicatorsInRegionByEcoItem"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/get-stocks-within-factor-range-in-region:
    post:
      description: Retrieves stocks within a specific factor value range. Call GetMultipleStocksCurrentFinanceDataByFSitems
        conversation first for fsitem value. Use default minimum float if Factor_lower is absent and maximum float if
        Factor_upper is not provided.
      operationId: GetStocksWithinFactorRangeInRegion
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetStocksWithinFactorRangeInRegion"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/get-stocks-with-multiple-factors:
    post:
      description: Retrieves stocks in a region matching multiple factor ranges. Factors defined by fsitem, factor_lower,
        factor_upper, and period_typ, specified in path with underscores.
      operationId: GetStocksWithMultipleFactors
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetStocksWithMultipleFactors"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/get-stocks-with-multiple-factor-model-back-test:
    post:
      description: Retrieves backtesting simulation results for a model matching multiple factor ranges in a region. Factors
        defined by fsitem, factor_lower, factor_upper, period_typ, specified in the path with underscores. Results shown
        in markdown table format.
      operationId: GetStocksWithMultipleFactorModelBackTest
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetStocksWithMultipleFactorModelBackTest"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/get-find-stocks-passed-technical-indicator-criteria:
    post:
      description: |+
        Retrieve stocks that have passed specific technical indicator criteria.


      operationId: GetFindStocksPassedTechnicalIndicatorCriteria
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetFindStocksPassedTechnicalIndicatorCriteria"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/get-industry-top-stocks-based-on-topic:
    post:
      description: Provides recommended stocks in industries based on a specified topic. Use FindIndustryCodes conversation to
        find related industries first. Input industries as IndustryCode1_IndustryCode2_... (e.g., 1111_2222_1222_...).
        Use FindIndustryCodes conversation to find relevant industries.
      operationId: GetIndustryTopStocksBasedOnTopic
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetIndustryTopStocksBasedOnTopic"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/get-outlook-for-industries-in-region:
    post:
      description: |
        Provides a detailed outlook across various industries in a region

        This endpoint delivers a comprehensive analysis and future outlook of industries.
      operationId: GetOutlookForIndustriesInRegion
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetOutlookForIndustriesInRegion"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/get-industry-factor-median-value:
    post:
      description: Returns median factor values for industries in a region, specified by ISO Alpha-2 code. Industry detail
        level ranges from 1 (least) to 5 (most detailed), defaulting to 2.
      operationId: GetIndustryFactorMedianValue
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetIndustryFactorMedianValue"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/get-outlook-for-stock-market:
    post:
      description: >
        Provides a detailed outlook report for market .


        This endpoint delivers a comprehensive analysis and future outlook of overall stock market or today's stock market
      operationId: GetOutlookForStockMarket
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetOutlookForStockMarket"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/retrieve-regulatory-docs-by-region:
    post:
      description: Accesses documents from regulatory agencies like exchanges and financial authorities for a specified
        region. Retrieves latest documents by ISO Alpha-2 code, including FOMC minutes and disclosure materials.
      operationId: RetrieveRegulatoryDocsByRegion
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RetrieveRegulatoryDocs"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/get-historical-dates-matching-with-current-equity-index-trend:
    post:
      description: Retrieve historical dates with price trends similar to the current trend of a specified index, returning a
        list of dates where the index's historical price movement matches the current trend, displayed in markdown table
        format.
      operationId: GetHistoricalDatesMatchingWithCurrentEquityIndexTrend
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetHistoricalDatesMatchingWithCurrentEquityIndexTrend"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/get-historical-dates-matching-with-current-economic-value:
    post:
      description: Identifies historical dates with price trends similar to current ones based on specified economic
        indicators (ecoitems). Users input ecoitems as a series of numbers, each separated by underscores.
      operationId: GetHistoricalDatesMatchingWithCurrentEconomicValue
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetHistoricalDatesMatchingWithCurrentEconomicValue"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/get-post-fin-ind-or-idx-mov-since-date:
    post:
      description: >
        Analyze Trends Following a Historical Date Based on Topic


        This endpoint provides an analysis of financial trends and changes occurring after a specified historical date, focused on a selected topic.
      operationId: GetPostFinIndOrIdxMovSinceDate
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetPostFinIndOrIdxMovSinceDate"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/get-equity-index-changes-after:
    post:
      description: >
        Retrieve companies based on theme or sector query.


        Returns the top 20 companies with business descriptions that have high semantic similarity with the provided query.
      operationId: getEquityIndexChangesAfter
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetEquityIndexChangesAfter"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/theme-sector-stock-search:
    post:
      description: >
        Retrieve companies based on theme or sector query.


        Returns the top 20 companies with business descriptions that have high semantic similarity with the provided query.
      operationId: ThemeSectorStockSearch
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ThemeSectorStockSearch"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/get-et-fs-containing-stock:
    post:
      description: |
        It shows a list of ETFs containing the stock entered by the user.

        Returns a list of ETFs that include the specified stock.
      operationId: GetETFsContainingStock
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetETFsContainingStock"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/get-etf-holdings:
    post:
      description: >+
        It shows a list of ETFs containing the stock entered by the user.show top 20 stocks in ETF. Find Ticker by GPT
        assistant.


      operationId: GetETFHoldings
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetETFHoldings"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
  /cosmos/get-optimal-etf-portfolio-by-investors-requirements:
    post:
      description: >
        Retrieve the optimal ETF allocation for a specified target return and investment period.


        A module that presents the optimal ETF portfolio when the user specifies the expected rate of return and the investment period.
      operationId: GetOptimalETFPortfolioByInvestorsRequirements
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetOptimalETFPortfolioByInvestorsRequirements"
        required: true
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: string
        "400":
          description: "Invalid value for: headers, Invalid value for: body"
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ""
          content:
            text/plain:
              schema:
                type: string
components:
  schemas:
    AnalyzeStockByTopic:
      required:
        - ticker
        - region
        - topic
        - prompt
      type: object
      properties:
        ticker:
          type: string
          description: Ticker symbol of the stock.
        region:
          type: string
          description: The region code of the stock in ISO Alpha-2 format.
        topic:
          $ref: "#/components/schemas/Topic"
        prompt:
          type: string
          description: user-written prompts
    DataType:
      type: string
      description: The data_type based on which the stocks are to be ranked. If the data_type is 'return', the ranking is
        based on the returns from the specified date to the present.
      enum:
        - Return
        - BoolioScore
        - FinancialData
        - MarketCapitalization
    Feature:
      type: string
      description: Feature for the stock analysis.
      enum:
        - Profitability
        - Growth
        - Undervalued
        - Momentum
        - FinancialStability
        - Sentiment
        - ShareholderReturn
    GetETFHoldings:
      required:
        - etfticker
        - etfregion
        - prompt
      type: object
      properties:
        etfticker:
          type: string
          description: Ticker symbol of the etf.
        etfregion:
          type: string
          description: The region code of the etf.
        prompt:
          type: string
          description: user-written prompts
    GetETFsContainingStock:
      required:
        - stockTicker
        - stockRegion
        - prompt
      type: object
      properties:
        stockTicker:
          type: string
          description: The stock ticker symbol to search within ETFs.
        stockRegion:
          type: string
          description: The region where the stock is traded.
        prompt:
          type: string
          description: user-written prompts
    GetEquityIndexChangesAfter:
      required:
        - startdate
        - region
        - prompt
      type: object
      properties:
        startdate:
          type: string
          description: The format of the date is yyyymmdd. For instance, 20230627 refers to June 27, 2023.
        region:
          type: string
          description: The ISO2 region code.
        prompt:
          type: string
          description: user-written prompts
    GetFindStocksPassedTechnicalIndicatorCriteria:
      required:
        - region
        - technicalIndicator
        - prompt
      type: object
      properties:
        region:
          type: string
          description: ISO Alpha-2 region code of the stocks.
        technicalIndicator:
          $ref: "#/components/schemas/TechnicalIndicator"
        prompt:
          type: string
          description: user-written prompts
    GetHighOrLowCorrelatedStocksWithEconomicIndicatorsInRegionByEcoItem:
      required:
        - region
        - numStocks
        - ecoitem
        - isHighest
        - prompt
      type: object
      properties:
        region:
          type: string
          description: The region code of the stock in ISO Alpha-2 format.
        numStocks:
          type: integer
          description: The number of stocks to return.
          format: int32
        ecoitem:
          type: integer
          description: The code of the economic indicator. Find correct ecoitem by calling getEcoItem(OperationID)
          format: int32
        isHighest:
          type: integer
          description: Binary string variable to determine if the highest (when 1) or lowest (when 0) returning stocks are to be
            fetched.
          format: int32
        prompt:
          type: string
          description: user-written prompts
    GetHistoricalDatesMatchingWithCurrentEconomicValue:
      required:
        - ecoitems
        - prompt
      type: object
      properties:
        ecoitems:
          type: string
          description: A series of economic indicators specified as numbers in a single string, separated by underscores (e.g.,
            "8_9_11").
        prompt:
          type: string
          description: user-written prompts
    GetHistoricalDatesMatchingWithCurrentEquityIndexTrend:
      required:
        - index
        - prompt
      type: object
      properties:
        index:
          type: string
        prompt:
          type: string
          description: user-written prompts
    GetIndustryFactorMedianValue:
      required:
        - region
        - industryLevel
        - prompt
      type: object
      properties:
        region:
          type: string
          description: The ISO Alpha-2 code of the region.
        industryLevel:
          type: integer
          description: The level of detail for the industry classification. Ranges from 1 to 5, with a default value of 2.
          format: int32
        prompt:
          type: string
          description: user-written prompts
    GetIndustryTopStocksBasedOnTopic:
      required:
        - industryCodes
        - topic
        - region
        - basedate
        - prompt
      type: object
      properties:
        industryCodes:
          type: string
          description: Before start find industry_codes by using getIndustryCodes
        topic:
          type: string
          description: "enum: [boolio score, market capitalization]"
        region:
          type: string
          description: The region code of the stock in ISO Alpha-2 format. If not specified, the default region is 'ALL'.
        basedate:
          type: string
          description: The reference date for the stock ranking in yyyymmdd format. For 'return' topic, it represents the start
            date for calculating returns. For other topics, the default is today's date.
        prompt:
          type: string
          description: user-written prompts
    GetMultipleStocksCurrentFinanceDataByFSitems:
      required:
        - tickers
        - regions
        - periodTyp
        - fsitems
        - prompt
      type: object
      properties:
        tickers:
          type: string
          description: Tickers are symbol of the stocks. It is separated by underscore. for example "aapl_005930_tsla_..."
        regions:
          type: string
          description: The region codes of the stocks in ISO Alpha-2 format. It is separated by underscore. for example
            "us_kr_us_..."
        periodTyp:
          type: string
          description: Type of period for which the data is to be fetched. 'A' for annual data, 'I' for other period(interim) data
            including 'Trailing Twelve' types.
        fsitems:
          type: string
          description: Financial (account, factor) Item Numbers for which the data is to be fetched. item fsitem information in
            endpoint /fsitem/. The fsitems are separated by underscore. for example 1001_1551
        prompt:
          type: string
          description: user-written prompts
    GetMultipleStocksPriceTimeSeriesFromStartDateToToday:
      required:
        - tickers
        - regions
        - startdate
        - format
        - prompt
      type: object
      properties:
        tickers:
          type: string
          description: Tickers are symbols of the stocks, separated by underscores. For example, "aapl_005930_tsla_..."
        regions:
          type: string
          description: The region codes of the stocks in ISO Alpha-2 format, separated by underscores. For example, "us_kr_us_..."
        startdate:
          type: string
          description: The format of the date is yyyymmdd. For instance, 20230627 refers to June 27, 2023.
        format:
          type: string
          description: The format for the output data. Set to "markdown" for Markdown format.
        prompt:
          type: string
          description: user-written prompts
    GetOptimalETFPortfolioByInvestorsRequirements:
      required:
        - targetReturn
        - investmentPeriod
        - prompt
      type: object
      properties:
        targetReturn:
          type: number
          description: The target return rate that the user wants to achieve, in percentage.
          format: double
        investmentPeriod:
          type: integer
          description: The investment period that the user is planning to invest, in years.
          format: int32
        prompt:
          type: string
          description: user-written prompts
    GetOutlookForIndustriesInRegion:
      required:
        - region
        - prompt
      type: object
      properties:
        region:
          type: string
          description: The region code of the market in ISO Alpha-2 format.
        prompt:
          type: string
          description: user-written prompts
    GetOutlookForStockMarket:
      required:
        - marketTopic
        - region
        - prompt
      type: object
      properties:
        marketTopic:
          $ref: "#/components/schemas/MarketTopic"
        region:
          type: string
          description: The ISO Alpha-2 country code of the region. default value is 'US'
        prompt:
          type: string
          description: user-written prompts
    GetPortfolioAnalysis:
      required:
        - tickers
        - regions
        - weights
        - prompt
      type: object
      properties:
        tickers:
          type: string
          description: Stock tickers, separated by underscore. For example "005930_AAPL_TSLA".
        regions:
          type: string
          description: ISO Alpha-2 region codes of the stocks, separated by underscore. For example "kr_us_us".
        weights:
          type: string
          description: Portfolio weights of each stock as real numbers, separated by underscore. For example "20.0_30.0_50.0".
        prompt:
          type: string
          description: user-written prompts
    GetPostFinIndOrIdxMovSinceDate:
      required:
        - topic
        - date
        - region
        - prompt
      type: object
      properties:
        topic:
          type: string
          description: The topic of analysis. Use 'overall' for a general analysis of financial trends or 'equity index' for a
            specific focus on the stock market.
        date:
          type: string
        region:
          type: string
          description: ISO Alpha-2 country code.
        prompt:
          type: string
          description: user-written prompts
    GetStocksWithMultipleFactorModelBackTest:
      required:
        - region
        - fsitems
        - factorLowers
        - factorUppers
        - periodTyps
        - prompt
      type: object
      properties:
        region:
          type: string
          description: The region in which the stock is located. The region code of the stock in ISO Alpha-2 format. Korea
            (KOSPI200), USA (S&P500), Japan(TOPIX500) China (CSI300) Europe(EUROSTOXX) Backtesting is performed in this
            manner.
        fsitems:
          type: string
          description: Financial Item Numbers for which the data is to be fetched, separated by underscores.
        factorLowers:
          type: string
          description: Lower limits for the factor ranges, separated by underscores.
        factorUppers:
          type: string
          description: Upper limits for the factor ranges, separated by underscores. if it is null fill value as 1E+38
        periodTyps:
          type: string
          description: Period types for which the data is to be fetched, separated by underscores. 'A' for annual data, 'I' for
            other period (interim) data including 'Trailing Twelve' types.
        prompt:
          type: string
          description: user-written prompts
    GetStocksWithMultipleFactors:
      required:
        - region
        - fsitems
        - factorLowers
        - factorUppers
        - periodTyps
        - prompt
      type: object
      properties:
        region:
          type: string
          description: The region in which the stock is located. The region code of the stock in ISO Alpha-2 format.
        fsitems:
          type: string
          description: Financial Item Numbers for which the data is to be fetched, separated by underscores.
        factorLowers:
          type: string
          description: Lower limits for the factor ranges, separated by underscores.
        factorUppers:
          type: string
          description: Upper limits for the factor ranges, separated by underscores.
        periodTyps:
          type: string
          description: Period types for which the data is to be fetched, separated by underscores. 'A' for annual data, 'I' for
            other period (interim) data including 'Trailing Twelve' types.
        prompt:
          type: string
          description: user-written prompts
    GetStocksWithinFactorRangeInRegion:
      required:
        - region
        - fsitem
        - factorLower
        - factorUpper
        - periodTyp
        - prompt
      type: object
      properties:
        region:
          type: string
          description: The region in which the stock is located. The region code of the stock in ISO Alpha-2 format.
        fsitem:
          type: integer
          description: Financial (account, factor) Item Number for which the data is to be fetched. **You MUST first use the
            /fsitem/ endpoint to find the valid fsitem number.**
          format: int32
        factorLower:
          type: number
          description: The lower limit of the factor range.
          format: double
        factorUpper:
          type: number
          description: The upper limit of the factor range. if it is null fill value as 1E+38
          format: double
        periodTyp:
          type: string
          description: Type of period for which the data is to be fetched. 'A' for annual data, 'I' for other period(interim) data
            including 'Trailing Twelve' types.
        prompt:
          type: string
          description: user-written prompts
    GetTopStocksInRegionBasedOnTopics:
      required:
        - region
        - dataType
        - numStocks
        - basedate
        - item
        - periodTyp
        - sign
        - prompt
      type: object
      properties:
        region:
          type: string
          description: The region code of the stock in ISO Alpha-2 format.
        dataType:
          $ref: "#/components/schemas/DataType"
        numStocks:
          type: integer
          description: The number of top-ranked stocks.
          format: int32
        basedate:
          type: string
          description: The reference date for the stock ranking in yyyymmdd format. Only 'return' topic, it represents the start
            date for calculating returns. For other topics, the default is today's date.
        item:
          type: integer
          description: Represents an FSItem number if the topic is 'financial data'.For all other topics, the default value is 0.
            use /fsitem/ to find correct fsitem.
          format: int32
        periodTyp:
          type: string
          description: Type of period for which the data is to be fetched. 'A' for annual data, 'I' for other period(interim) data
            including 'Trailing Twelve' types. it is needed if the topic is only 'financial data' else just 'A'
        sign:
          type: integer
          description: Indicates the direction for ranking stocks. '1' for top stocks, '-1' for bottom stocks.
          format: int32
        prompt:
          type: string
          description: user-written prompts
    HistoricalFindata:
      required:
        - ticker
        - region
        - periodType
        - startDate
        - prompt
      type: object
      properties:
        ticker:
          type: string
          description: Ticker symbol of the stock.
        region:
          type: string
          description: The region code of the stock in ISO Alpha-2 format.
        periodType:
          $ref: "#/components/schemas/PeriodType"
        fsItems:
          type: array
          items:
            type: integer
            format: int32
          description: Financial (account, factor) Item Numbers that can be found by 'FindFSItems' function.
        startDate:
          type: string
          format: date
        prompt:
          type: string
          description: user-written prompts
    HistoricalPrice:
      required:
        - ticker
        - region
        - startDate
        - prompt
      type: object
      properties:
        ticker:
          type: string
          description: Ticker symbol of the stock.
        region:
          type: string
          description: The region code of the stock in ISO Alpha-2 format.
        startDate:
          type: string
          format: date
        prompt:
          type: string
          description: user-written prompts
    ListAllEcoItems:
      required:
        - dummy
        - prompt
      type: object
      properties:
        dummy:
          type: boolean
        prompt:
          type: string
          description: user-written prompts
    ListAllFSItems:
      required:
        - dummy
        - prompt
      type: object
      properties:
        dummy:
          type: boolean
        prompt:
          type: string
          description: user-written prompts
    ListAllIndustryItems:
      required:
        - dummy
        - prompt
      type: object
      properties:
        dummy:
          type: boolean
        prompt:
          type: string
          description: user-written prompts
    ListAllInvestorIds:
      required:
        - dummy
        - prompt
      type: object
      properties:
        dummy:
          type: boolean
        prompt:
          type: string
          description: user-written prompts
    MarketTopic:
      type: string
      description: Specify the market_topic for detailed market outlook.
      enum:
        - Forecast
        - Today
    PeriodType:
      type: string
      enum:
        - Annual
        - Interim
    RetrieveRegulatoryDocs:
      required:
        - source
        - topic
        - region
        - prompt
      type: object
      properties:
        source:
          type: string
          description: |
            The source category of the regulatory agency documents.

            enum: [FOMC, Disclosure]
        topic:
          type: string
          description: |-
            The specific topic within the chosen source. Covers categories under FOMC minutes.

            enum: [filing, federal_reserve_mins, monetary_policy_committee, beige_books, fed_fund_rate_projection]

            'filing' is a general category for other regulatory documents.
        region:
          type: string
          description: The ISO Alpha-2 country code of the region.
        prompt:
          type: string
          description: user-written prompts
    StockFeatures:
      required:
        - ticker
        - region
        - feature
        - prompt
      type: object
      properties:
        ticker:
          type: string
          description: Ticker symbol of the stock.
        region:
          type: string
          description: The region code of the stock in ISO Alpha-2 format.
        feature:
          $ref: "#/components/schemas/Feature"
        prompt:
          type: string
          description: user-written prompts
    TechnicalIndicator:
      type: string
      description: The technical indicator criterion that stocks have passed. This list will expand over time.
      enum:
        - 52WeekHighBreakthrough
        - PositiveMovingAverageAlignment
    ThemeSectorStockSearch:
      required:
        - query
        - region
        - prompt
      type: object
      properties:
        query:
          type: string
          description: A theme or term. If it's a term, its definition should be provided. Must be in English. If not, need to be
            translated english.
        region:
          type: string
          description: The ISO2 region code.
        prompt:
          type: string
          description: user-written prompts
    Topic:
      type: string
      enum:
        - Overall
        - AnalystOpinion
        - EarningCall
        - CorrelationWithEconomicIndicators
        - Valuation
        - FactorPercentileInIndustry
        - EstimatedEPSAndSales
        - SalesBySegment
        - ESGScore
        - BoolioScore
        - TechnicalAnalysis
        - Filing
        - MarketPsych
        - MarketCap
        - EquityIndex