Boolio Legacy · GPT-Aktionen

openapi: 3.0.1
info:
  title: Boolio GPT
  description: Provides investment information and analysis, covering stock market, industry, and individual stock analysis.
  version: 'v1'
servers:
  - url: https://dev-gpt.ngrok.io
paths:
  /fsitem/:      
    get:
      operationId: getFSItem
      summary: Identifies the Financial Item Number (FSItem) for a given factor or indicator. This endpoint provides financial item numbers and their corresponding content.                                                              
      responses: {'200': {description: Successful operation.}}
  /ecoitem/:      
    get:
      operationId: getEcoItem
      summary: Retrieves the economic indicator codes.                        
      responses: {'200': {description: Successful operation.}}
  /industrycodes/:      
    get:
      operationId: getIndustryCodes
      summary: Returns industry codes        
      responses: {'200': {description: Successful operation.}}
  /investorid/:
    get:
      operationId: getInvestorId
      summary: Identifies the investor's ID for a given investor's name.
      description: This endpoint provides investor IDs and their corresponding names.
                  If an exact match is not found, it returns IDs for similar names.
                  For example, asking 'What is the ID for investor Jon Doe?' will return the corresponding ID.
                  Hide investor id code
      responses: {'200': {description: Successful operation.}}  
  /single-stock/information/{ticker}/{region}/{topic}:  
    get:
      operationId: getDetailedStockAnalysisReportBasedOnTopics
      summary: Provide Detailed Stock Analysis Reports Based on Specific Topics.
      description: This operation delivers comprehensive analysis reports on stocks, tailored to specific topics as requested by users. The stock is identified by its ticker and region (ISO Alpha-2 format),
      parameters:
      - in: path
        name: ticker
        schema:
          type: string
        description: The ticker symbol of the stock.
        required: true
      - in: path
        name: region
        schema:
          type: string
        description: The region code of the stock in ISO Alpha-2 format.
        required: true
      - in: path      
        name: topic
        schema:
          type: string
          enum: ['overall','analyst opinion','earning call','correlation with economic indicators'
                  ,'valuation','factor percentile in industry','estimated eps and sales'
                  ,'sales by segment','esg score','boolio score','technical anlaysis','filing'
                  ,'market psych score']
        description: Specify the topic for detailed stock analysis.
        required: true
      responses: {'200': {description: Successful operation.}}
  /single-stock/information/feature/{ticker}/{region}/{feature}:      
    get:
      operationId: getStockFeatureScoreAnalysisReport
      summary: Analyze Key Features of a Stock for Informed Investment Decisions. The available features are Profitability, Growth, Undervalued, Momentum, FinancialStability, Sentiment, and ShareholderReturn.
      description: Use this endpoint to analyze specific features of a stock, including Profitability, Growth, Undervalued, Momentum, Financial Stability, Sentiment, and Shareholder Return. Each feature is evaluated with detailed metrics and an overall score between 0 and 100.
      parameters:
      - in: path
        name: ticker
        schema:
          type: string
        description: Ticker symbol of the stock.
        required: true        
      - in: path      
        name: region
        schema:
          type: string
        description: The region code of the stock.
        required: true
      - in: path        
        name: feature
        schema:
          type: string
          enum: [Profitability, Growth, Undervalued, Momentum, FinancialStability, Sentiment, ShareholderReturn]
        description: Feature for the stock analysis.           
        required: true                  
      responses: {'200': {description: Successful operation.}}
  /single-stock/timeseries/financial/{ticker}/{region}/{period_typ}/{fsitems}/{startdate}:  
    get:
      operationId: getCompanyTimeSeriesFinanceDataByFSItem
      summary: Access Historical Financial Data for Multiple FSItems in a Single Company
      description: Query historical data for multiple FSItems in a company from a start date (default 5 years ago). Must use /fsitem/ endpoint to identify FSItem numbers.
      parameters:
      - in: path
        name: ticker
        schema:
          type: string
        description: Ticker symbol of the stock.
        required: true        
      - in: path      
        name: region
        schema:
          type: string
        description: The region code of the stock in ISO Alpha-2 format.
        required: true
      - in: path        
        name: period_typ
        schema:
          type: string
          enum: ['A','I']
        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.           
        required: true        
      - in: path      
        name: fsitems
        schema:
          type: string
        description: Financial (account, factor) Item Numbers for which to be fetched. Use the /fsitem/ endpoint or the getFSItem operation to identify FSItem numbers. Input these numbers in a string separated by underscores, e.g., "1551_1001_8301".
        required: true                  
      - in: path
        name: startdate
        schema:
          type: string
        description: The format of the date is yyyymmdd. For instance, 20230627 refers to June 27, 2023.
        required: true      
      - in: query
        name: format
        schema:
          type: string
          default: "markdown"
        description: The format for the output data. Set to "markdown" for Markdown format.
      responses: {'200': {description: Successful operation.}}
  /single-stock/timeseries/price/{ticker}/{region}/{startdate}:    
    get:
      operationId: getStockPriceTimeSeriesFromStartDateToToday
      summary: Retrieve Stock Prices from Specified Date(startdate) to Present.
      description: This operation fetches stock prices for a given ticker and region, starting from a user-specified date (format yyyymmdd) up to today. If no start date is designated, it defaults to the beginning of the current year (yyyy0101).
      parameters:
      - in: path
        name: ticker
        schema:          
          type: string
        description: Ticker symbol of the stock.
        required: true
      - in: path      
        name: region
        schema:
          type: string
        description: The region code of the stock in ISO Alpha-2 format.
        required: true
      - in: path
        name: startdate
        schema:
          type: string
          description: The format of the date is yyyymmdd. For instance, 20230627 refers to June 27, 2023. 
        required: true        
      responses: {'200': {description: Successful operation.}}
  /multiple-stocks/information/financial/{tickers}/{regions}/{period_typ}/{fsitems}:
    get:    
      operationId: getMultipleStocksCurrentFinanceDataByFSitems
      summary: 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 '_'.
      descrpition: For example, user want to know Samsung Electronics and Apple, the tickers would be "005930_AAPL", and the regions would be "KR_US".                   
      parameters:
      - in: path
        name: tickers
        schema:
          type: string
        description: Tickers are symbol of the stocks. It is separated by underscore. for example "aapl_005930_tsla_..."
        required: true
      - in: path      
        name: regions
        schema:          
          type: string
        description: The region codes of the stocks in ISO Alpha-2 format. It is separated by underscore. for example "us_kr_us_..."
        required: true
      - in: path        
        name: period_typ
        schema:
          type: string
          enum: ['A','I']
        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.           
        required: true        
      - in: path
        name: fsitems
        schema:
          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
        required: true                  
      responses: {'200': {description: Successful operation.}}  
  /multiple-stocks/portfolio-analysis/{tickers}/{regions}/{weights}:
    get:    
      operationId: getPortfolioAnalysis
      summary: An API that provides portfolio characteristic analysis for user-specified stocks.
      description: 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.
      parameters:
      - in: path
        name: tickers
        schema:
          type: string
        description: Stock tickers, separated by underscore. For example "005930_AAPL_TSLA".
        required: true
      - in: path      
        name: regions
        schema:          
          type: string
        description: ISO Alpha-2 region codes of the stocks, separated by underscore. For example "kr_us_us".
        required: true
      - in: path        
        name: weights
        schema:
          type: string
        description: Portfolio weights of each stock as real numbers, separated by underscore. For example "20.0_30.0_50.0".
        required: true                  
      responses: 
        '200': 
          description: Successful operation with portfolio analysis report.  
  /multiple-stocks/timeseries/price/{tickers}/{regions}/{startdate}:  
    get:    
      operationId: getMultipleStocksPriceTimeSeriesFromStartDateToToday
      summary: Retrieves historical stock prices for multiple user-specified stocks. The tickers and regions are used to distinguish stocks as a pair.
      description: This endpoint fetches historical stock prices for specified stocks, starting from a user-specified date. The ticker and region code are separated by an underscore. For example, to know the prices of Samsung Electronics and Apple, the tickers would be "005930_AAPL", and the regions would be "KR_US".
      parameters:
      - in: path
        name: tickers
        schema:
          type: string
        description: Tickers are symbols of the stocks, separated by underscores. For example, "aapl_005930_tsla_..."
        required: true
      - in: path      
        name: regions
        schema:          
          type: string
        description: The region codes of the stocks in ISO Alpha-2 format, separated by underscores. For example, "us_kr_us_..."
        required: true
      - in: path
        name: startdate
        schema:
          type: string
        description: The format of the date is yyyymmdd. For instance, 20230627 refers to June 27, 2023.
        required: true 
      - in: query
        name: format
        schema:
          type: string
          default: "markdown"
        description: The format for the output data. Set to "markdown" for Markdown format.                  
      responses: {'200': {description: Successful operation.}}
  /region/top-stocks/information/{region}/{data_type}/{num_stocks}/{basedate}/{item}/{period_typ}/{sign}:
    get:    
      operationId: getTopStocksInRegionBasedOnTopics
      summary: Retrieves the top (num_stocks) stocks in a specific region based on a specified topic. 
      description: 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.
      parameters:
      - in: path      
        name: region
        schema:
          type: string
        description: The region code of the stock in ISO Alpha-2 format.
        required: true
      - in: path
        name: data_type
        schema:
          type: string
          enum: ['return','boolio score','financial data', 'market capitalization']
        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.        
        required: true
      - in: path      
        name: num_stocks
        schema:
          type: integer
        description: The number of top-ranked stocks.
        required: true        
      - in: path
        name: basedate
        schema:
          type: string
          default: 'today'
        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.
        required: true     
      - in: path
        name: item
        schema:
          type: integer
          default: 0
        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.
        required: true                
      - in: path
        name: period_typ
        schema:
          type: string
          enum: ['A','I']                  
        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'
        required: true             
      - in: path
        name: sign
        schema:
          type: integer
          default: 1
          enum: [-1, 1]
        description: Indicates the direction for ranking stocks. '1' for top stocks, '-1' for bottom stocks.
        required: true        
      responses: {'200': {description: Successful operation.}}
  /region/top-stocks/correlation/economic-indicators/{region}/{num_stocks}/{ecoitem}/{is_highest}:  
    get:
      operationId: getHighOrLowCorrelatedStocksWithEconomicIndicatorsInRegionByEcoItem      
      summary: This function retrieves the 'num_stocks' number of stocks that have
        the highest or lowest correlation with a given economic indicator from a specified
        country(region).
      description: This endpoint gathers stock data from the specified region and returns a list of the 'num_stocks' stocks with the highest or lowest correlation with a given economic indicator.
      parameters:
      - in: path
        name: region
        schema:
          type: string
        description: The region code of the stock in ISO Alpha-2 format.
        required: true
      - in: path
        name: num_stocks
        schema:
          type: integer
        description: The number of stocks to return.
        required: true
      - in: path
        name: ecoitem
        schema:
          type: integer
        description: The code of the economic indicator. Find correct ecoitem by calling getEcoItem(OperationID) 
        required: true
      - in: path
        name: is_highest
        schema:
          type: integer
          enum: [1,0]          
        description: Binary string variable to determine if the highest (when 1) or lowest (when 0) returning stocks are to be fetched.
        required: true
      responses: {'200': {description: Successful operation.}}
  /region/stocks-within-factor-range/{region}/{fsitem}/{factor_lower}/{factor_upper}/{period_typ}:
    get:      
      operationId: getStocksWithinFactorRangeInRegion
      summary: Retrieves stocks within a certain factor range.      
      description: Factor value range filters stocks. **Before using this endpoint, you MUST call the /fsitem/ endpoint to retrieve the appropriate fsitem value.** 
                   If Factor_lower is absent, input minimum float by default. If Factor_upper isn't provided, input maximum float.
      parameters:
      - in: path
        name: region
        schema:
          type: string
        description: The region in which the stock is located. The region code of the stock in ISO Alpha-2 format.
        required: true
      - in: path        
        name: fsitem
        schema:
          type: integer
          format: int32
          minimum: 1
          maximum: 65535
        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.**
        required: true
      - in: path
        name: factor_lower
        schema:
          type: float
        description: The lower limit of the factor range.
        required: true
      - in: path
        name: factor_upper
        schema:
          type: float
        description: The upper limit of the factor range.
        required: true
      - in: path      
        name: period_typ
        schema:          
          type: string
          enum: ['A','I']
        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.           
        required: true          
      responses: {'200': {description: Successful operation.}}    
  /region/stocks-multi-factor-range/screen/{region}/{fsitems}/{factor_lowers}/{factor_uppers}/{period_typs}:
    get:      
      operationId: getStocksWithMultipleFactors
      summary: Retrieves stocks matching multiple factor ranges in a region.
      description: Retrieves stocks matching multiple factor ranges in a region. Each factor range is defined by fsitem, factor_lower, factor_upper, and period_typ. 
        These parameters are now specified in the path, separated by underscores.
      parameters:
      - in: path
        name: region
        schema:
          type: string
        description: The region in which the stock is located. The region code of the stock in ISO Alpha-2 format.
        required: true
      - in: path
        name: fsitems
        schema:
          type: string
        description: Financial Item Numbers for which the data is to be fetched, separated by underscores.
        required: true
      - in: path
        name: factor_lowers
        schema:
          type: string
        description: Lower limits for the factor ranges, separated by underscores.
        required: true
      - in: path
        name: factor_uppers
        schema:
          type: string
        description: Upper limits for the factor ranges, separated by underscores.
        required: true
      - in: path
        name: period_typs
        schema:
          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.
        required: true
      responses: {'200': {description: Successful operation.}}
  /region/stocks-multi-factor-range/backtest/{region}/{fsitems}/{factor_lowers}/{factor_uppers}/{period_typs}:
    get:      
      operationId: getStocksWithMultipleFactorModelBackTest
      summary: Retrieves backtesting simulation result of model matching multiple factor ranges in a region
      description: Retrieves backtesting simulation result of model matching multiple factor ranges in a region. 
                   Each factor range is defined by fsitem, factor_lower, factor_upper, and period_typ. These parameters are now specified in the path, separated by underscores.
                   Show the result table as markdown table format. 
      parameters:
      - in: path
        name: region
        schema:
          type: string
          enum: ['KR','US','JP','CN','EU']
        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.
        required: true
      - in: path
        name: fsitems
        schema:
          type: string
        description: Financial Item Numbers for which the data is to be fetched, separated by underscores.
        required: true
      - in: path
        name: factor_lowers
        schema:
          type: string
        description: Lower limits for the factor ranges, separated by underscores.
        required: true
      - in: path
        name: factor_uppers
        schema:
          type: string
        description: Upper limits for the factor ranges, separated by underscores. if it is null fill value as 1E+38
        required: true
      - in: path
        name: period_typs
        schema:
          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.
        required: true
      responses: {'200': {description: Successful operation.}}    
  /region/stocks-passed-technical-indicator-criteria/{region}/{technical_indicator}:
    get:
      operationId: getFindStocksPassedTechnicalIndicatorCriteria
      summary: Retrieve stocks that have passed specific technical indicator criteria.      
      parameters:
      - in: path
        name: region
        schema:
          type: string        
        description: ISO Alpha-2 region code of the stocks.
        required: true
      - in: path
        name: technical_indicator
        schema:
          type: string
          enum: ['52weeks high breakthrough', 'Sequentially Aligned Moving Averages']        
        description: The technical indicator criterion that stocks have passed. This list will expand over time.
        required: true
      responses: {'200': {description: Successful operation.}}
  /region/industries/top-stocks/{industry_codes}/{topic}/{region}/{basedate}:
    get:
      operationId: getIndustryTopStocksBasedOnTopic
      summary: Provides recommended stocks in industries based on a specified topic. Before Start, use /industrycodes/ to find related industries.
      description: Input industries are formatted as IndustryCode1_IndustryCode2_IndustryCode3_... (e.g., 1111_2222_1222_...). 
                   /industrycodes/ endpoint to find related industries those user wants to know.
      parameters:
      - in: path
        name: industry_codes
        schema:
          type: string
        description: Before start find industry_codes by using getIndustryCodes
        required: true
      - in: path
        name: topic
        schema:
          type: string
          enum: ['boolio score', 'financial data', 'market capitalization', 'return']
        description: The topic based on which the stocks are to be ranked. If the topic is 'return', the ranking is based on the returns from the specified date to the present.
        required: true
      - in: path
        name: region
        schema:
          type: string
          default: 'ALL'
        description: The region code of the stock in ISO Alpha-2 format. If not specified, the default region is 'ALL'.
        required: true
      - in: path
        name: basedate
        schema:
          type: string
          default: 'today'
        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.
        required: true             
      responses: {'200': {description: Successful operation.}}
  /region/industries/outlook/{region}:
    get:
      operationId: getOutlookForIndustriesInRegion
      summary: Provides a detailed outlook across various industries in a region
      description: This endpoint delivers a comprehensive analysis and future outlook of industries.
      parameters:            
      - in: path      
        name: region        
        schema:
          type: string
        description: The region code of the market in ISO Alpha-2 format.
        required: true      
      responses: {'200': {description: Successful operation.}}  
  /region/industries/factor-median-value/{region}/{industry_level}:
    get:
      operationId: getIndustryFactorMedianValue
      summary: Returns median values of factors for industries within a specified region.
      description: >
        This endpoint provides the median values of various factors for industries in a given region. 
        The region is specified by its ISO Alpha-2 code. The level of industry detail can be specified, 
        ranging from 1 (least detailed) to 5 (most detailed), with a default value of 2.
      parameters:
      - in: path
        name: region
        schema:
          type: string          
        description: The ISO Alpha-2 code of the region.
        required: true
      - in: path
        name: industry_level
        schema:
          type: integer
          default: 2
          minimum: 1
          maximum: 5
        description: The level of detail for the industry classification. Ranges from 1 to 5, with a default value of 2.
        required: true
      responses: {'200': {description: Successful operation.}}  
  /market/outlook/:  
    get:
      operationId: getOutlookForStockMarket
      summary: Provides a detailed outlook report for market .
      description: This endpoint delivers a comprehensive analysis and future outlook of overall stock market.
      responses: {'200': {description: Successful operation.}}              
  /investor/holdings/{investor_id}:  
    get:
      operationId: getnvestorHoldings
      summary: Returns the holdings of a given  investor based on their ID.
      description: This endpoint provides the holdings held by an investor. It is focus on Investor not single stock or company
                   If you want to know investors for single company, call endpoint single-stock/information/
      parameters:
      - in: path
        name: investor_id
        schema:
          type: integer
        description: Provide the ID of the investor to get the corresponding holdings. use endpoint getInvestorId(OperationID)
        required: true
      responses: {'200': {description: Successful operation.}}    
  
      elif topic == "major shareholders":
         return get_single_stock_shareholder_information(ticker,region)  
  /news/filing-today/{region}:
    get:
      operationId: getTodaysFilingData
      summary: Retrieves today's filing documents for a specified region.
      description: This endpoint provides access to the latest filing documents released on the current day for the specified region. The region is identified by its ISO Alpha-2 country code.
      parameters:
      - in: path
        name: region
        schema:
          type: string
        description: The ISO Alpha-2 country code of the region.
        required: true
      responses: {'200': {description: Successful operation.}}      
  /historical-date/matching-with/current-price-trends/{index}:
    get:
      operationId: getHistoricalDatesMatchingWithCurrentEquityIndexTrend
      summary: Retrieve historical dates with price trends similar to the current trend of a specified index.
      description: Returns a list of historical dates where the price movement of the specified index closely matched the current price trend on markdown table format.
      parameters:
        - in: path
          name: index
          schema:
            type: string
            enum: [KOSPI200, S&P500, NASDAQ100, TOPIX500, CSI300, EUROSTOXX]
            description: The identifier of the index for which to find matching historical price trends. Possible values are KOSPI200, S&P500, NASDAQ100, TOPIX500, CSI300, EUROSTOXX.
          required: true      
      responses: {'200': {description: Successful operation.}}        
  /historical-date/matching-with/current-economic-value/{ecoitems}:
    get:
      operationId: getHistoricalDatesMatchingWithCurrentEconomicValue
      summary: Finds historical dates with price trends similar to current trends based on specified economic indicators.
      description: This endpoint identifies historical dates where the price trends closely matched the current trend, based on a series of specified economic indicators (ecoitems). Users must input the ecoitems as a series of numbers, each separated by underscores.
      parameters:
      - in: path
        name: ecoitems
        schema:
          type: string
        description: A series of economic indicators specified as numbers in a single string, separated by underscores (e.g., "8_9_11").
        required: true
      responses:
        '200':
          description: Successful operation, returns historical dates with similar price trends to the current trend based on the specified economic indicators.  
  /historical-date/analysis-post-date/{topic}/{date_}/{region}:    
    get:
      operationId: getPostFinIndOrIdxMovSinceDate
      summary: Analyze Trends Following a Historical Date Based on Topic
      description: This endpoint provides an analysis of financial trends and changes occurring after a specified historical date, focused on a selected topic.
      parameters:
      - in: path
        name: topic
        schema:
          type: string
          enum: ['overall', 'equity index']  # Restricts the topic to either 'overall' or 'equity index'.
        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.
        required: true
      - in: path
        name: date_
        schema:
          type: string
          pattern: '^\d{4}-\d{2}-\d{2}$'  # This pattern ensures the date format is yyyy-mm-dd.                
        required: true
      - in: path
        name: region
        schema:
          type: string          
        description: ISO Alpha-2 country code.
        required: true
      responses: {'200': {description: Successful operation.}}            
  /theme/stocks/{query}/{region}:
    get:
      operationId: themeSectorStockSearch
      summary: Retrieve companies based on theme or sector query.
      description: Returns the top 20 companies with business descriptions that have high semantic similarity with the provided query.
      parameters:
      - in: path
        name: query
        schema:
          type: string
          pattern: '^[a-zA-Z\s]*$'  # This pattern ensures only English letters and spaces are allowed.
        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.
        required: true
      - in: path
        name: region
        schema:
          type: string          
        description: The ISO2 region code.
        required: true
      responses: {'200': {description: Successful operation.}}    
  /eft/with-stock/{stockTicker}/{stockRegion}:  
    get:
      operationId: getETFsContainingStock
      summary: It shows a list of ETFs containing the stock entered by the user.
      description: Returns a list of ETFs that include the specified stock.
      parameters:
      - in: path
        name: stockTicker
        schema:
          type: string
        description: The stock ticker symbol to search within ETFs.
        required: true
      - in: path      
        name: stockRegion
        schema:
          type: string
        description: The region where the stock is traded.
        required: true            
      responses: {'200': {description: Successful operation.}}            
  /eft/holdings/{etfticker}/{etfregion}:
    get:
      operationId: getETFHoldings
      summary: It shows a list of ETFs containing the stock entered by the user.show top 20 stocks in ETF. Find Ticker by GPT assistant.       
      parameters: 
      - in: path
        name: etfticker
        schema:
          type: string
        description: Ticker symbol of the etf.
        required: true
      - in: path      
        name: etfregion
        schema:
          type: string
        description: The region code of the etf.
        required: true      
      responses: {'200': {description: Successful operation.}}
  /etf/optimal-portfolio/{target_return}/{investment_period}:    
    get:
      operationId: getOptimalETFPortfolioByInvestorsRequirements
      summary: Retrieve the optimal ETF allocation for a specified target return and investment period.
      description: A module that presents the optimal ETF portfolio when the user specifies the expected rate of return and the investment period.
      parameters:
      - in: path
        name: target_return
        schema:
          type: float
        required: true
        description: The target return rate that the user wants to achieve, in percentage.
      - in: path
        name: investment_period
        schema:
          type: int
        required: true
        description: The investment period that the user is planning to invest, in years.
      responses: {'200': {description: Successful operation.}}