openbb-akshare 0.3.5__py3-none-any.whl

openbb_akshare/__init__.py

@@ -0,0 +1,28 @@
+"""openbb_akshare OpenBB Platform Provider."""
+
+from openbb_core.provider.abstract.provider import Provider
+from openbb_akshare.models.company_news import AKShareCompanyNewsFetcher
+from openbb_akshare.models.equity_quote import AKShareEquityQuoteFetcher
+from openbb_akshare.models.equity_historical import AKShareEquityHistoricalFetcher
+from openbb_akshare.models.historical_dividends import AKShareHistoricalDividendsFetcher
+from openbb_akshare.models.available_indices import AKShareAvailableIndicesFetcher
+
+# mypy: disable-error-code="list-item"
+
+provider = Provider(
+    name="akshare",
+    description="Data provider for openbb-akshare.",
+    # Only add 'credentials' if they are needed.
+    # For multiple login details, list them all here.
+    # credentials=["api_key"],
+    website="https://akshare.akfamily.xyz/",
+    # Here, we list out the fetchers showing what our provider can get.
+    # The dictionary key is the fetcher's name, used in the `router.py`.
+    fetcher_dict={
+        "AvailableIndices": AKShareAvailableIndicesFetcher,
+        "CompanyNews": AKShareCompanyNewsFetcher,
+        "EquityQuote": AKShareEquityQuoteFetcher,
+        "EquityHistorical": AKShareEquityHistoricalFetcher,
+        "HistoricalDividends": AKShareHistoricalDividendsFetcher,
+    }
+)

openbb_akshare/models/__init__.py

@@ -0,0 +1 @@
+"""AKShare models directory."""

openbb_akshare/models/available_indices.py

@@ -0,0 +1,72 @@
+"""AKShare Available Indices Model."""
+
+# pylint: disable=unused-argument
+
+from typing import Any, Dict, List, Optional
+from datetime import (
+    date as dateType
+)
+
+from openbb_core.provider.abstract.fetcher import Fetcher
+from openbb_core.provider.standard_models.available_indices import (
+    AvailableIndicesData,
+    AvailableIndicesQueryParams,
+)
+from pydantic import Field
+
+
+class AKShareAvailableIndicesQueryParams(AvailableIndicesQueryParams):
+    """AKShare Available Indices Query.
+
+    Source: https://akshare.akfamily.xyz/data/index/index.html#id22
+    """
+
+
+class AKShareAvailableIndicesData(AvailableIndicesData):
+    """AKShare Available Indices Data."""
+
+    __alias_dict__ = {
+        "name": "display_name",
+        "symbol": "index_code",
+    }
+
+    publish_date: Optional[dateType] = Field(
+        default=None,
+        description="The date of the index published.",
+    )
+    symbol: str = Field(description="Symbol for the index.")
+
+
+class AKShareAvailableIndicesFetcher(
+    Fetcher[
+        AKShareAvailableIndicesQueryParams,
+        List[AKShareAvailableIndicesData],
+    ]
+):
+    """Transform the query, extract and transform the data from the AKShare endpoints."""
+
+    @staticmethod
+    def transform_query(params: Dict[str, Any]) -> AKShareAvailableIndicesQueryParams:
+        """Transform the query params."""
+        return AKShareAvailableIndicesQueryParams(**params)
+
+    @staticmethod
+    def extract_data(
+        query: AKShareAvailableIndicesQueryParams,  # pylint disable=unused-argument
+        credentials: Optional[Dict[str, str]],
+        **kwargs: Any,
+    ) -> List[Dict]:
+        """Extract the data."""
+        import akshare as ak
+
+        index_stock_info_df = ak.index_stock_info()
+        index_stock_info_df["currency"] = "CNY"
+
+        return index_stock_info_df.to_dict(orient="records")
+
+    @staticmethod
+    def transform_data(
+        query: AKShareAvailableIndicesQueryParams, data: List[Dict], **kwargs: Any
+    ) -> List[AKShareAvailableIndicesData]:
+        """Return the transformed data."""
+        return [AKShareAvailableIndicesData.model_validate(d) for d in data]

openbb_akshare/models/company_news.py

@@ -0,0 +1,100 @@
+"""AKShare Company News Model."""
+
+# pylint: disable=unused-argument
+from typing import Any, Dict, List, Optional
+
+from openbb_core.provider.abstract.fetcher import Fetcher
+from openbb_core.provider.standard_models.company_news import (
+    CompanyNewsData,
+    CompanyNewsQueryParams,
+)
+from pydantic import Field, field_validator
+
+class AKshareCompanyNewsQueryParams(CompanyNewsQueryParams):
+    """AKShare Company News Query.
+
+    Source: https://so.eastmoney.com/news/s
+    """
+
+    __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}}
+
+    @field_validator("symbol", mode="before", check_fields=False)
+    @classmethod
+    def _symbol_mandatory(cls, v):
+        """Symbol mandatory validator."""
+        if not v:
+            raise ValueError("Required field missing -> symbol")
+        return v
+
+
+class AKShareCompanyNewsData(CompanyNewsData):
+    """AKShare Company News Data."""
+
+    source: Optional[str] = Field(
+        default=None, description="Source of the news article"
+    )
+
+
+class AKShareCompanyNewsFetcher(
+    Fetcher[
+        AKshareCompanyNewsQueryParams,
+        List[AKShareCompanyNewsData],
+    ]
+):
+    """Transform the query, extract and transform the data from the AKShare endpoints."""
+
+    @staticmethod
+    def transform_query(params: Dict[str, Any]) -> AKshareCompanyNewsQueryParams:
+        """Define example transform_query.
+
+        Here we can pre-process the query parameters and add any extra parameters that
+        will be used inside the extract_data method.
+        """
+        return AKshareCompanyNewsQueryParams(**params)
+
+    @staticmethod
+    async def aextract_data(
+        query: AKshareCompanyNewsQueryParams,
+        credentials: Optional[Dict[str, str]],
+        **kwargs: Any,
+    ) -> List[dict]:
+        """Extract data."""
+        # pylint: disable=import-outside-toplevel
+        import asyncio  # noqa
+        from openbb_core.provider.utils.errors import EmptyDataError
+        from openbb_core.provider.utils.helpers import get_requests_session
+        import akshare as ak
+
+        results: list = []
+        symbols = query.symbol.split(",")  # type: ignore
+        async def get_one(symbol):
+            data = ak.stock_news_em(symbol)
+            for idx, d in data.iterrows():
+                new_content: dict = {}
+                new_content["text"] = d["新闻内容"]
+                new_content["url"] = d["新闻链接"]
+                new_content["source"] = d["文章来源"]
+                new_content["title"] = d["新闻标题"]
+                new_content["date"] = d["发布时间"]
+
+                results.append(new_content)
+
+        tasks = [get_one(symbol) for symbol in symbols]
+
+        await asyncio.gather(*tasks)
+
+        if not results:
+            raise EmptyDataError("No data was returned for the given symbol(s)")
+
+        return results
+
+    @staticmethod
+    def transform_data(
+        query: AKshareCompanyNewsQueryParams, data: List[dict], **kwargs: Any
+    ) -> List[AKShareCompanyNewsData]:
+        """Define example transform_data.
+
+        Right now, we're converting the data to fit our desired format.
+        You can apply other transformations to it here.
+        """
+        return [AKShareCompanyNewsData(**d) for d in data]

openbb_akshare/models/equity_historical.py

@@ -0,0 +1,118 @@
+"""AKShare Equity Historical Price Model."""
+
+# pylint: disable=unused-argument
+
+import asyncio
+from datetime import datetime
+from typing import Any, Dict, List, Literal, Optional
+from warnings import warn
+
+from dateutil.relativedelta import relativedelta
+from openbb_core.provider.abstract.fetcher import Fetcher
+from openbb_core.provider.standard_models.equity_historical import (
+    EquityHistoricalData,
+    EquityHistoricalQueryParams,
+)
+from openbb_core.provider.utils.descriptions import (
+    DATA_DESCRIPTIONS,
+    QUERY_DESCRIPTIONS,
+)
+from openbb_core.provider.utils.errors import EmptyDataError
+from openbb_core.provider.utils.helpers import (
+    amake_request,
+    get_querystring,
+)
+from openbb_fmp.utils.helpers import get_interval
+from pydantic import Field
+
+
+class AKShareEquityHistoricalQueryParams(EquityHistoricalQueryParams):
+    """AKShare Equity Historical Price Query.
+
+    Source: https://financialmodelingprep.com/developer/docs/#Stock-Historical-Price
+    """
+
+    __json_schema_extra__ = {
+        "symbol": {"multiple_items_allowed": True},
+        "period": {"choices": ["daily", "weekly", "monthly"]},
+    }
+
+    period: Literal["daily", "weekly", "monthly"] = Field(
+        default="daily", description=QUERY_DESCRIPTIONS.get("period", "")
+    )
+
+
+class AKShareEquityHistoricalData(EquityHistoricalData):
+    """AKShare Equity Historical Price Data."""
+
+    __alias_dict__ = {
+        "date": "日期",
+        "open": "开盘",
+        "close": "收盘",
+        "high": "最高",
+        "low": "最低",
+        "volume": "成交量",
+        "change": "涨跌额",
+        "change_percent": "涨跌幅",
+    }
+
+    change: Optional[float] = Field(
+        default=None,
+        description="Change in the price from the previous close.",
+    )
+    change_percent: Optional[float] = Field(
+        default=None,
+        description="Change in the price from the previous close, as a normalized percent.",
+        json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
+    )
+
+
+class AKShareEquityHistoricalFetcher(
+    Fetcher[
+        AKShareEquityHistoricalQueryParams,
+        List[AKShareEquityHistoricalData],
+    ]
+):
+    """Transform the query, extract and transform the data from the AKShare endpoints."""
+
+    @staticmethod
+    def transform_query(params: Dict[str, Any]) -> AKShareEquityHistoricalQueryParams:
+        """Transform the query params."""
+        transformed_params = params
+
+        now = datetime.now().date()
+        if params.get("start_date") is None:
+            transformed_params["start_date"] = now - relativedelta(years=1)
+
+        if params.get("end_date") is None:
+            transformed_params["end_date"] = now
+
+        return AKShareEquityHistoricalQueryParams(**transformed_params)
+
+    @staticmethod
+    def extract_data(
+        query: AKShareEquityHistoricalQueryParams,
+        credentials: Optional[Dict[str, str]],
+        **kwargs: Any,
+    ) -> List[Dict]:
+        """Return the raw data from the AKShare endpoint."""
+        from openbb_akshare.utils.helpers import ak_download
+
+        data = ak_download(symbol=query.symbol, start_date=query.start_date, end_date=query.end_date, period="daily", adjust="")
+
+        if data.empty:
+            raise EmptyDataError()
+
+        return data
+
+
+    @staticmethod
+    def transform_data(
+        query: AKShareEquityHistoricalQueryParams, data: List[Dict], **kwargs: Any
+    ) -> List[AKShareEquityHistoricalData]:
+        """Return the transformed data."""
+
+        return [
+            AKShareEquityHistoricalData.model_validate(d)
+            for d in data.to_dict("records")
+        ]

openbb_akshare/models/equity_quote.py

@@ -0,0 +1,153 @@
+"""AKShare Equity Quote Model."""
+
+# pylint: disable=unused-argument
+
+from typing import Any, Dict, List, Optional
+from warnings import warn
+
+from openbb_core.provider.abstract.fetcher import Fetcher
+from openbb_core.provider.standard_models.equity_quote import (
+    EquityQuoteData,
+    EquityQuoteQueryParams,
+)
+from pydantic import Field
+import logging
+from openbb_akshare.utils.tools import setup_logger, normalize_symbol, get_symbol_base
+
+logger = logging.getLogger(__name__)
+
+class AKShareEquityQuoteQueryParams(EquityQuoteQueryParams):
+    """AKShare Equity Quote Query."""
+
+    __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}}
+
+
+class AKShareEquityQuoteData(EquityQuoteData):
+    """AKShare Equity Quote Data."""
+
+    __alias_dict__ = {
+        "symbol": "代码",
+        "name": "名称",
+        "exchange": "交易所",
+        "last_price": "现价",
+        "open": "今开",
+        "close": "均价",
+        "high": "最高",
+        "low": "最低",
+        "prev_close": "昨收",
+        "year_high": "52周最高",
+        "year_low": "52周最低",
+        "volume": "成交量",
+        "change": "涨跌",
+        "participant_timestamp": "时间",
+        "market_cap": "流通值",
+        "pe_ratio": "市盈率(动)",
+        "pe_ratio_ttm": "市盈率(TTM)",
+        "turnover": "成交额",
+        "currency": "货币",
+    }
+
+    market_cap: Optional[float] = Field(
+        default=None,
+        description="Market capitalization.",
+    )
+    pe_ratio: Optional[float] = Field(
+        default=None,
+        description="Price-to-earnings ratio.",
+    )
+    pe_ratio_ttm: Optional[float] = Field(
+        default=None,
+        description="Price-to-earnings ratio (TTM).",
+    )
+    turnover: Optional[float] = Field(
+        default=None,
+        description="Turnover of the stock.",
+    )
+    currency: Optional[str] = Field(
+        default=None,
+        description="Currency of the price.",
+    )
+
+
+class AKShareEquityQuoteFetcher(
+    Fetcher[AKShareEquityQuoteQueryParams, List[AKShareEquityQuoteData]]
+):
+    """AKShare Equity Quote Fetcher."""
+
+    @staticmethod
+    def transform_query(params: Dict[str, Any]) -> AKShareEquityQuoteQueryParams:
+        """Transform the query."""
+        return AKShareEquityQuoteQueryParams(**params)
+
+    @staticmethod
+    async def aextract_data(
+        query: AKShareEquityQuoteQueryParams,
+        credentials: Optional[Dict[str, str]],
+        **kwargs: Any,
+    ) -> List[Dict]:
+        """Extract the raw data from AKShare."""
+        # pylint: disable=import-outside-toplevel
+        import asyncio  # noqa
+        from curl_adapter import CurlCffiAdapter
+        from openbb_core.provider.utils.helpers import get_requests_session
+        import akshare as ak
+
+        symbols = query.symbol.split(",")
+        results = []
+        fields = ['代码', 
+                  '名称', 
+                  '交易所', 
+                  '现价', 
+                  '今开',
+                  '均价', 
+                  '最高', 
+                  '最低', 
+                  '昨收', 
+                  '52周最高', 
+                  '52周最低', 
+                  '成交量', 
+                  '涨跌', 
+                  '时间', 
+                  '流通值', 
+                  '市盈率(动)', 
+                  '市盈率(TTM)',
+                  '成交额', 
+                  '货币']
+        async def get_one(symbol):
+            """Get the data for one ticker symbol."""
+            result: dict = {}
+            ticker: dict = {}
+            try:
+                symbol_b, symbol_f, market = normalize_symbol(symbol)
+                if market == "SH" or market == "SZ":
+                    symbol = market+symbol_b
+                elif market == "BJ":
+                    symbol = "NQ"+symbol_b
+                ticker_df = ak.stock_individual_spot_xq(symbol)
+                if ticker_df.empty:
+                    logger.debug("ticker_df is empty.")
+                else:
+                    ticker = dict(zip(ticker_df['item'], ticker_df['value']))
+            except Exception as e:
+                warn(f"Error getting data for {symbol}: {e}")
+            if ticker:
+                for field in fields:
+                    if field in ticker:
+                        result[field] = ticker.get(field, None)
+                if result:
+                    results.append(result)
+
+        tasks = [get_one(symbol) for symbol in symbols]
+
+        await asyncio.gather(*tasks)
+
+        return results
+
+    @staticmethod
+    def transform_data(
+        query: AKShareEquityQuoteQueryParams,
+        data: List[Dict],
+        **kwargs: Any,
+    ) -> List[AKShareEquityQuoteData]:
+        """Transform the data."""
+        return [AKShareEquityQuoteData.model_validate(d) for d in data]

openbb_akshare/models/historical_dividends.py

@@ -0,0 +1,109 @@
+"""AKShare Historical Dividends Model."""
+
+# pylint: disable=unused-argument
+from datetime import (
+    date as dateType,
+    datetime,
+)
+from typing import Any, Dict, List, Optional
+from pydantic import Field, field_validator
+
+from openbb_core.app.model.abstract.error import OpenBBError
+from openbb_core.provider.abstract.fetcher import Fetcher
+from openbb_core.provider.standard_models.historical_dividends import (
+    HistoricalDividendsData,
+    HistoricalDividendsQueryParams,
+)
+
+import logging
+logger = logging.getLogger(__name__)
+
+class AKShareHistoricalDividendsQueryParams(HistoricalDividendsQueryParams):
+    """AKShare Historical Dividends Query."""
+
+
+class AKShareHistoricalDividendsData(HistoricalDividendsData):
+    """AKShare Historical Dividends Data. All data is split-adjusted."""
+    reported_date: Optional[dateType] = Field(
+        default=None,
+        description="Earnings Announcement Date.",
+    )
+    description: Optional[str] = Field(
+        default=None,
+        description="Record date of the historical dividends.",
+    )
+    record_date: Optional[dateType] = Field(
+        default=None,
+        description="Record date of the historical dividends.",
+    )
+    declaration_date: Optional[dateType] = Field(
+        default=None,
+        description="Declaration date of the historical dividends.",
+    )
+    @field_validator(
+        "declaration_date",
+        "record_date",
+        "reported_date",
+        "ex_dividend_date",
+        mode="before",
+        check_fields=False,
+    )
+    @classmethod
+    def date_validate(cls, v: str):  # pylint: disable=E0213
+        """Validate dates."""
+        if not isinstance(v, str):
+            return v
+        return dateType.fromisoformat(v) if v else None
+    
+class AKShareHistoricalDividendsFetcher(
+    Fetcher[
+        AKShareHistoricalDividendsQueryParams, List[AKShareHistoricalDividendsData]
+    ]
+):
+    """AKShare Historical Dividends Fetcher."""
+
+    @staticmethod
+    def transform_query(
+        params: Dict[str, Any],
+    ) -> AKShareHistoricalDividendsQueryParams:
+        """Transform the query."""
+        return AKShareHistoricalDividendsQueryParams(**params)
+
+    @staticmethod
+    def extract_data(
+        query: AKShareHistoricalDividendsQueryParams,
+        credentials: Optional[Dict[str, str]],
+        **kwargs: Any,
+    ) -> List[Dict]:
+        """Extract the raw data from AKShare."""
+        # pylint: disable=import-outside-toplevel
+        from openbb_akshare.utils.tools import normalize_symbol
+        from openbb_akshare.utils.helpers import get_a_dividends, get_hk_dividends
+
+        symbol_b, symbol_f, market = normalize_symbol(query.symbol)
+        if market == "HK":
+            dividends = get_hk_dividends(symbol_b)
+        else:
+            dividends = get_a_dividends(symbol_b)
+
+        logger.info(
+            "Fetched historical dividends:\n%s",
+            dividends
+        )
+        return dividends
+
+    @staticmethod
+    def transform_data(
+        query: AKShareHistoricalDividendsQueryParams,
+        data: List[Dict],
+        **kwargs: Any,
+    ) -> List[AKShareHistoricalDividendsData]:
+        """Transform the data."""
+        #return [AKShareHistoricalDividendsData.model_validate(d) for d in data]
+        result: List[AKShareHistoricalDividendsData] = []
+        for d in data:
+            result.append(AKShareHistoricalDividendsData(**d))
+        logger.info(
+            "Transformed historical dividends completed.\n"
+        )        
+        return result

openbb_akshare/openbb.py

@@ -0,0 +1,43 @@
+"""openbb_akshare OpenBB Platform extension."""
+from pathlib import Path
+from typing import List, Optional, Union
+
+from openbb_core.app.static.app_factory import BaseApp as _BaseApp
+from openbb_core.app.static.app_factory import create_app as _create_app
+from openbb_core.app.static.package_builder import \
+    PackageBuilder as _PackageBuilder
+
+_this_dir = Path(__file__).parent.resolve()
+_PackageBuilder(_this_dir).auto_build()
+
+
+def build(
+    modules: Optional[Union[str, List[str]]] = None,
+    lint: bool = True,
+    verbose: bool = False,
+) -> None:
+    """Build extension modules.
+
+    Parameters
+    ----------
+    modules : Optional[List[str]], optional
+        The modules to rebuild, by default None
+        For example: "/news" or ["/news", "/crypto"]
+        If None, all modules are rebuilt.
+    lint : bool, optional
+        Whether to lint the code, by default True
+    verbose : bool, optional
+        Enable/disable verbose mode
+    """
+    _PackageBuilder(_this_dir, lint, verbose).build(modules)
+
+
+try:
+    # pylint: disable=import-outside-toplevel
+    from openbb_akshare.package.__extensions__ import Extensions as _Extensions
+
+    obb: Union[_BaseApp, _Extensions] = _create_app(_Extensions)  # type: ignore
+    sdk = obb
+except (ImportError, ModuleNotFoundError):
+    print("Failed to import extensions.")
+    obb = sdk = _create_app()  # type: ignore

openbb_akshare/router.py

@@ -0,0 +1,48 @@
+"""openbb-akshare router command example."""
+
+import requests
+from openbb_core.app.model.command_context import CommandContext
+from openbb_core.app.model.obbject import OBBject
+from openbb_core.app.provider_interface import (ExtraParams, ProviderChoices,
+                                                StandardParams)
+from openbb_core.app.query import Query
+from openbb_core.app.router import Router
+from pydantic import BaseModel
+
+router = Router(prefix="")
+
+
+@router.command(methods=["GET"])
+async def get_example(symbol: str = "AAPL") -> OBBject[dict]:
+    """Get options data."""
+    base_url = "https://www.cboe.com/education/tools/trade-optimizer/symbol-info"
+
+    response = requests.get(base_url + f"?symbol={symbol}", timeout=5).json()
+    return OBBject(results=response["details"])
+
+
+@router.command(methods=["POST"])
+async def post_example(
+    data: dict,
+    bid_col: str = "bid",
+    ask_col: str = "ask",
+) -> OBBject[dict]:
+    """Calculate mid and spread."""
+    bid = data[bid_col]
+    ask = data[ask_col]
+    mid = (bid + ask) / 2
+    spread = ask - bid
+
+    return OBBject(results={"mid": mid, "spread": spread})
+
+
+# pylint: disable=unused-argument
+@router.command(model="Example")
+async def model_example(
+    cc: CommandContext,
+    provider_choices: ProviderChoices,
+    standard_params: StandardParams,
+    extra_params: ExtraParams,
+) -> OBBject[BaseModel]:
+    """Example Data."""
+    return await OBBject.from_query(Query(**locals()))

openbb_akshare/utils/__init__.py

@@ -0,0 +1 @@
+"""AKShare utils directory."""