settfex 0.1.0__py3-none-any.whl

settfex/__init__.py

@@ -0,0 +1,63 @@
+"""settfex - Stock Exchange of Thailand (SET) and Thailand Futures Exchange (TFEX) Data Library.
+
+A modern Python library for fetching real-time and historical data from Thai financial markets.
+
+Usage:
+    >>> import asyncio
+    >>> from settfex.services.set import Stock, get_stock_list
+    >>>
+    >>> async def main():
+    ...     # Fetch stock list
+    ...     stock_list = await get_stock_list()
+    ...     print(f"Total stocks: {stock_list.count}")
+    ...
+    ...     # Fetch stock data
+    ...     stock = Stock("CPALL")
+    ...     highlight = await stock.get_highlight_data()
+    ...     print(f"Market Cap: {highlight.market_cap:,.0f}")
+    >>>
+    >>> asyncio.run(main())
+"""
+
+__version__ = "0.1.0"
+__author__ = "batt"
+__license__ = "MIT"
+
+# Public API exports - import commonly used classes/functions
+from settfex.services.set import (
+    CompanyProfile,
+    Stock,
+    StockHighlightData,
+    StockListResponse,
+    StockProfile,
+    get_company_profile,
+    get_highlight_data,
+    get_profile,
+    get_stock_list,
+)
+
+# Utility exports
+from settfex.utils.data_fetcher import AsyncDataFetcher, FetcherConfig
+from settfex.utils.logging import setup_logger
+
+__all__ = [
+    # Version info
+    "__version__",
+    "__author__",
+    "__license__",
+    # SET Services - Most commonly used
+    "Stock",
+    "get_stock_list",
+    "get_highlight_data",
+    "get_profile",
+    "get_company_profile",
+    # Data Models
+    "StockListResponse",
+    "StockHighlightData",
+    "StockProfile",
+    "CompanyProfile",
+    # Utilities
+    "AsyncDataFetcher",
+    "FetcherConfig",
+    "setup_logger",
+]

settfex/services/__init__.py

@@ -0,0 +1 @@
+# Services for SET and TFEX data

settfex/services/set/__init__.py

@@ -0,0 +1,130 @@
+"""SET (Stock Exchange of Thailand) services."""
+
+from settfex.services.set.constants import (
+    SET_BASE_URL,
+    SET_BOARD_OF_DIRECTOR_ENDPOINT,
+    SET_COMPANY_PROFILE_ENDPOINT,
+    SET_CORPORATE_ACTION_ENDPOINT,
+    SET_FINANCIAL_BALANCE_SHEET_ENDPOINT,
+    SET_FINANCIAL_CASH_FLOW_ENDPOINT,
+    SET_FINANCIAL_INCOME_STATEMENT_ENDPOINT,
+    SET_NVDR_HOLDER_ENDPOINT,
+    SET_PRICE_PERFORMANCE_ENDPOINT,
+    SET_STOCK_HIGHLIGHT_DATA_ENDPOINT,
+    SET_STOCK_LIST_ENDPOINT,
+    SET_STOCK_PROFILE_ENDPOINT,
+    SET_STOCK_SHAREHOLDER_ENDPOINT,
+    SET_TRADING_STAT_ENDPOINT,
+)
+from settfex.services.set.list import (
+    StockListResponse,
+    StockListService,
+    StockSymbol,
+    get_stock_list,
+)
+from settfex.services.set.stock import (
+    Account,
+    BalanceSheet,
+    BoardOfDirectorService,
+    CashFlow,
+    CompanyProfile,
+    CompanyProfileService,
+    CorporateAction,
+    CorporateActionService,
+    Director,
+    FinancialService,
+    FinancialStatement,
+    IncomeStatement,
+    NVDRHolderData,
+    NVDRHolderService,
+    PricePerformanceData,
+    PricePerformanceService,
+    ShareholderData,
+    ShareholderService,
+    Stock,
+    StockHighlightData,
+    StockHighlightDataService,
+    StockProfile,
+    StockProfileService,
+    TradingStat,
+    TradingStatService,
+    get_balance_sheet,
+    get_board_of_directors,
+    get_cash_flow,
+    get_company_profile,
+    get_corporate_actions,
+    get_highlight_data,
+    get_income_statement,
+    get_nvdr_holder_data,
+    get_price_performance,
+    get_profile,
+    get_shareholder_data,
+    get_trading_stats,
+    normalize_language,
+    normalize_symbol,
+)
+
+__all__ = [
+    # Constants
+    "SET_BASE_URL",
+    "SET_STOCK_LIST_ENDPOINT",
+    "SET_STOCK_HIGHLIGHT_DATA_ENDPOINT",
+    "SET_STOCK_PROFILE_ENDPOINT",
+    "SET_COMPANY_PROFILE_ENDPOINT",
+    "SET_CORPORATE_ACTION_ENDPOINT",
+    "SET_STOCK_SHAREHOLDER_ENDPOINT",
+    "SET_NVDR_HOLDER_ENDPOINT",
+    "SET_BOARD_OF_DIRECTOR_ENDPOINT",
+    "SET_TRADING_STAT_ENDPOINT",
+    "SET_PRICE_PERFORMANCE_ENDPOINT",
+    "SET_FINANCIAL_BALANCE_SHEET_ENDPOINT",
+    "SET_FINANCIAL_INCOME_STATEMENT_ENDPOINT",
+    "SET_FINANCIAL_CASH_FLOW_ENDPOINT",
+    # Stock List Service
+    "StockListService",
+    "StockListResponse",
+    "StockSymbol",
+    "get_stock_list",
+    # Stock Class and Services
+    "Stock",
+    "StockHighlightDataService",
+    "StockHighlightData",
+    "get_highlight_data",
+    "StockProfileService",
+    "StockProfile",
+    "get_profile",
+    "CompanyProfileService",
+    "CompanyProfile",
+    "get_company_profile",
+    "CorporateActionService",
+    "CorporateAction",
+    "get_corporate_actions",
+    "ShareholderService",
+    "ShareholderData",
+    "get_shareholder_data",
+    "NVDRHolderService",
+    "NVDRHolderData",
+    "get_nvdr_holder_data",
+    "BoardOfDirectorService",
+    "Director",
+    "get_board_of_directors",
+    "TradingStatService",
+    "TradingStat",
+    "get_trading_stats",
+    "PricePerformanceService",
+    "PricePerformanceData",
+    "get_price_performance",
+    # Financial Service
+    "FinancialService",
+    "FinancialStatement",
+    "Account",
+    "BalanceSheet",
+    "IncomeStatement",
+    "CashFlow",
+    "get_balance_sheet",
+    "get_income_statement",
+    "get_cash_flow",
+    # Stock Utilities
+    "normalize_symbol",
+    "normalize_language",
+]

settfex/services/set/constants.py

@@ -0,0 +1,19 @@
+"""Constants and configuration for SET (Stock Exchange of Thailand) services."""
+
+# Base URL for all SET API endpoints
+SET_BASE_URL = "https://www.set.or.th"
+
+# API endpoints
+SET_STOCK_LIST_ENDPOINT = "/api/set/stock/list"
+SET_STOCK_HIGHLIGHT_DATA_ENDPOINT = "/api/set/stock/{symbol}/highlight-data"
+SET_STOCK_PROFILE_ENDPOINT = "/api/set/stock/{symbol}/profile"
+SET_COMPANY_PROFILE_ENDPOINT = "/api/set/company/{symbol}/profile"
+SET_CORPORATE_ACTION_ENDPOINT = "/api/set/stock/{symbol}/corporate-action"
+SET_STOCK_SHAREHOLDER_ENDPOINT = "/api/set/stock/{symbol}/shareholder"
+SET_NVDR_HOLDER_ENDPOINT = "/api/set/stock/{symbol}/nvdr-holder"
+SET_BOARD_OF_DIRECTOR_ENDPOINT = "/api/set/company/{symbol}/board-of-director"
+SET_TRADING_STAT_ENDPOINT = "/api/set/factsheet/{symbol}/trading-stat"
+SET_PRICE_PERFORMANCE_ENDPOINT = "/api/set/factsheet/{symbol}/price-performance"
+SET_FINANCIAL_BALANCE_SHEET_ENDPOINT = "/api/set/factsheet/{symbol}/financialstatement"
+SET_FINANCIAL_INCOME_STATEMENT_ENDPOINT = "/api/set/factsheet/{symbol}/financialstatement"
+SET_FINANCIAL_CASH_FLOW_ENDPOINT = "/api/set/factsheet/{symbol}/financialstatement"

settfex/services/set/list.py

@@ -0,0 +1,207 @@
+"""SET Stock List Service - Fetch list of stock details from SET API."""
+
+from typing import Any
+
+from loguru import logger
+from pydantic import BaseModel, ConfigDict, Field
+
+from settfex.services.set.constants import SET_BASE_URL, SET_STOCK_LIST_ENDPOINT
+from settfex.utils.data_fetcher import AsyncDataFetcher, FetcherConfig
+
+
+class StockSymbol(BaseModel):
+    """Model for individual stock symbol information."""
+
+    symbol: str = Field(description="Stock symbol/ticker")
+    name_th: str = Field(alias="nameTH", description="Company name in Thai")
+    name_en: str = Field(alias="nameEN", description="Company name in English")
+    market: str = Field(description="Market type (SET, mai, etc.)")
+    security_type: str = Field(alias="securityType", description="Security type")
+    type_sequence: int = Field(alias="typeSequence", description="Type sequence number")
+    industry: str = Field(description="Industry classification")
+    sector: str = Field(description="Sector classification")
+    query_sector: str = Field(alias="querySector", description="Queryable sector name")
+    is_iff: bool = Field(alias="isIFF", description="Is Infrastructure Fund Flag")
+    is_foreign_listing: bool = Field(
+        alias="isForeignListing", description="Is foreign listing flag"
+    )
+    remark: str = Field(default="", description="Additional remarks")
+
+    model_config = ConfigDict(
+        populate_by_name=True,  # Allow both field name and alias
+        str_strip_whitespace=True,  # Strip whitespace from strings
+    )
+
+
+class StockListResponse(BaseModel):
+    """Response model for stock list API."""
+
+    security_symbols: list[StockSymbol] = Field(
+        alias="securitySymbols", description="List of stock symbols"
+    )
+
+    model_config = ConfigDict(
+        populate_by_name=True,  # Allow both field name and alias
+    )
+
+    @property
+    def count(self) -> int:
+        """Get total count of securities."""
+        return len(self.security_symbols)
+
+    def filter_by_market(self, market: str) -> list[StockSymbol]:
+        """
+        Filter securities by market type.
+
+        Args:
+            market: Market type (e.g., 'SET', 'mai')
+
+        Returns:
+            List of stock symbols for the specified market
+        """
+        return [s for s in self.security_symbols if s.market.upper() == market.upper()]
+
+    def filter_by_industry(self, industry: str) -> list[StockSymbol]:
+        """
+        Filter securities by industry.
+
+        Args:
+            industry: Industry classification
+
+        Returns:
+            List of stock symbols in the specified industry
+        """
+        return [s for s in self.security_symbols if s.industry.upper() == industry.upper()]
+
+    def get_symbol(self, symbol: str) -> StockSymbol | None:
+        """
+        Get a specific stock symbol.
+
+        Args:
+            symbol: Stock symbol to find
+
+        Returns:
+            StockSymbol if found, None otherwise
+        """
+        for s in self.security_symbols:
+            if s.symbol.upper() == symbol.upper():
+                return s
+        return None
+
+
+class StockListService:
+    """
+    Service for fetching stock list from SET API.
+
+    This service provides async methods to fetch the complete list of stocks
+    traded on the Stock Exchange of Thailand (SET), including company names,
+    market classifications, and industry sectors.
+    """
+
+    def __init__(self, config: FetcherConfig | None = None) -> None:
+        """
+        Initialize the stock list service.
+
+        Args:
+            config: Optional fetcher configuration (uses defaults if None)
+
+        Example:
+            >>> # Uses SessionManager for automatic cookie handling
+            >>> service = StockListService()
+        """
+        self.config = config or FetcherConfig()
+        self.base_url = SET_BASE_URL
+        logger.info(f"StockListService initialized with base_url={self.base_url}")
+
+    async def fetch_stock_list(self) -> StockListResponse:
+        """
+        Fetch the complete list of stocks from SET API.
+
+        Returns:
+            StockListResponse containing all stock symbols and details
+
+        Raises:
+            Exception: If request fails or response cannot be parsed
+
+        Example:
+            >>> service = StockListService()
+            >>> response = await service.fetch_stock_list()
+            >>> print(f"Total stocks: {response.count}")
+            >>> print(f"SET stocks: {len(response.filter_by_market('SET'))}")
+        """
+        url = f"{self.base_url}{SET_STOCK_LIST_ENDPOINT}"
+
+        logger.info(f"Fetching stock list from {url}")
+
+        async with AsyncDataFetcher(config=self.config) as fetcher:
+            # Get optimized headers for SET API (includes all Incapsula bypass headers)
+            headers = AsyncDataFetcher.get_set_api_headers()
+
+            # Fetch JSON data from API - SessionManager handles cookies automatically
+            data = await fetcher.fetch_json(url, headers=headers)
+
+            # Parse and validate response using Pydantic
+            response = StockListResponse(**data)
+
+            logger.info(
+                f"Successfully fetched {response.count} stock symbols from SET API"
+            )
+
+            return response
+
+    async def fetch_stock_list_raw(self) -> dict[str, Any]:
+        """
+        Fetch stock list as raw dictionary without Pydantic validation.
+
+        Useful for debugging or when you need the raw API response.
+
+        Returns:
+            Raw dictionary from API
+
+        Raises:
+            Exception: If request fails
+
+        Example:
+            >>> service = StockListService()
+            >>> raw_data = await service.fetch_stock_list_raw()
+            >>> print(raw_data.keys())
+        """
+        url = f"{self.base_url}{SET_STOCK_LIST_ENDPOINT}"
+
+        logger.info(f"Fetching raw stock list from {url}")
+
+        async with AsyncDataFetcher(config=self.config) as fetcher:
+            # Get optimized headers for SET API
+            headers = AsyncDataFetcher.get_set_api_headers()
+
+            # Use provided session cookies or generate Incapsula-aware cookies
+            cookies = self.session_cookies or AsyncDataFetcher.generate_incapsula_cookies()
+
+            # Fetch JSON data
+            data = await fetcher.fetch_json(
+                url, headers=headers, cookies=cookies, use_random_cookies=False
+            )
+            logger.debug(f"Raw response keys: {list(data.keys()) if isinstance(data, dict) else type(data)}")  # noqa: E501
+            return data
+
+
+# Convenience function for quick access
+async def get_stock_list(config: FetcherConfig | None = None) -> StockListResponse:
+    """
+    Convenience function to fetch stock list.
+
+    Args:
+        config: Optional fetcher configuration
+
+    Returns:
+        StockListResponse with all stock symbols
+
+    Example:
+        >>> from settfex.services.set import get_stock_list
+        >>> # Uses SessionManager for automatic cookie handling
+        >>> response = await get_stock_list()
+        >>> for stock in response.security_symbols[:5]:
+        ...     print(f"{stock.symbol}: {stock.name_en}")
+    """
+    service = StockListService(config=config)
+    return await service.fetch_stock_list()

settfex/services/set/stock/__init__.py

@@ -0,0 +1,114 @@
+"""Stock-specific utilities and services for SET stock operations."""
+
+from settfex.services.set.stock.board_of_director import (
+    BoardOfDirectorService,
+    Director,
+    get_board_of_directors,
+)
+from settfex.services.set.stock.corporate_action import (
+    CorporateAction,
+    CorporateActionService,
+    get_corporate_actions,
+)
+from settfex.services.set.stock.financial import (
+    Account,
+    BalanceSheet,
+    CashFlow,
+    FinancialService,
+    FinancialStatement,
+    IncomeStatement,
+    get_balance_sheet,
+    get_cash_flow,
+    get_income_statement,
+)
+from settfex.services.set.stock.highlight_data import (
+    StockHighlightData,
+    StockHighlightDataService,
+    get_highlight_data,
+)
+from settfex.services.set.stock.nvdr_holder import (
+    NVDRHolderData,
+    NVDRHolderService,
+    get_nvdr_holder_data,
+)
+from settfex.services.set.stock.price_performance import (
+    PricePerformanceData,
+    PricePerformanceService,
+    get_price_performance,
+)
+from settfex.services.set.stock.profile_company import (
+    CompanyProfile,
+    CompanyProfileService,
+    get_company_profile,
+)
+from settfex.services.set.stock.profile_stock import (
+    StockProfile,
+    StockProfileService,
+    get_profile,
+)
+from settfex.services.set.stock.shareholder import (
+    ShareholderData,
+    ShareholderService,
+    get_shareholder_data,
+)
+from settfex.services.set.stock.stock import Stock
+from settfex.services.set.stock.trading_stat import (
+    TradingStat,
+    TradingStatService,
+    get_trading_stats,
+)
+from settfex.services.set.stock.utils import normalize_language, normalize_symbol
+
+__all__ = [
+    # Main Stock Class
+    "Stock",
+    # Utilities
+    "normalize_symbol",
+    "normalize_language",
+    # Highlight Data Service
+    "StockHighlightDataService",
+    "StockHighlightData",
+    "get_highlight_data",
+    # Profile Service
+    "StockProfileService",
+    "StockProfile",
+    "get_profile",
+    # Company Profile Service
+    "CompanyProfileService",
+    "CompanyProfile",
+    "get_company_profile",
+    # Corporate Action Service
+    "CorporateActionService",
+    "CorporateAction",
+    "get_corporate_actions",
+    # Shareholder Service
+    "ShareholderService",
+    "ShareholderData",
+    "get_shareholder_data",
+    # NVDR Holder Service
+    "NVDRHolderService",
+    "NVDRHolderData",
+    "get_nvdr_holder_data",
+    # Board of Director Service
+    "BoardOfDirectorService",
+    "Director",
+    "get_board_of_directors",
+    # Trading Statistics Service
+    "TradingStatService",
+    "TradingStat",
+    "get_trading_stats",
+    # Price Performance Service
+    "PricePerformanceService",
+    "PricePerformanceData",
+    "get_price_performance",
+    # Financial Service
+    "FinancialService",
+    "FinancialStatement",
+    "Account",
+    "BalanceSheet",
+    "IncomeStatement",
+    "CashFlow",
+    "get_balance_sheet",
+    "get_income_statement",
+    "get_cash_flow",
+]