lixinger-python 0.2.0__py3-none-any.whl → 0.3.1__py3-none-any.whl

lixinger/__init__.py

@@ -2,12 +2,11 @@ from lixinger.api.cn.company import get_company, get_equity_change, get_profile
 from lixinger.api.cn.company.candlestick import get_candlestick
 from lixinger.api.cn.company.fs.non_financial import get_non_financial_statements
 from lixinger.api.cn.company.fundamental import (
-    get_bank,
-    get_fundamental,
-    get_insurance,
-    get_non_financial,
-    get_other_financial,
-    get_security,
+    get_bank_fundamental,
+    get_insurance_fundamental,
+    get_non_financial_fundamental,
+    get_other_financial_fundamental,
+    get_security_fundamental,
 )
 from lixinger.api.cn.company.indices import get_indices
 from lixinger.api.cn.fund import (
@@ -70,10 +69,9 @@ __all__ = [
     "get_index_candlestick",
     "get_index_drawdown",
     "get_non_financial_statements",
-    "get_fundamental",
-    "get_non_financial",
-    "get_bank",
-    "get_insurance",
-    "get_security",
-    "get_other_financial",
+    "get_non_financial_fundamental",
+    "get_bank_fundamental",
+    "get_insurance_fundamental",
+    "get_security_fundamental",
+    "get_other_financial_fundamental",
 ]

lixinger/api/cn/company/__init__.py

@@ -5,7 +5,6 @@ from lixinger.api.cn.company.candlestick import CandlestickAPI, get_candlestick
 from lixinger.api.cn.company.company import CompanyAPI, get_company
 from lixinger.api.cn.company.dividend import DividendAPI, get_dividend
 from lixinger.api.cn.company.equity_change import EquityChangeAPI, get_equity_change
-from lixinger.api.cn.company.fundamental import FundamentalAPI
 from lixinger.api.cn.company.indices import IndicesAPI, get_indices
 from lixinger.api.cn.company.profile import CompanyProfileAPI, get_profile
 
@@ -18,8 +17,6 @@ __all__ = [
     # Equity
     "EquityChangeAPI",
     "get_equity_change",
-    # Fundamental
-    "FundamentalAPI",
     # Market data
     "CandlestickAPI",
     "get_candlestick",

lixinger/api/cn/company/company.py

@@ -36,11 +36,15 @@ class CompanyAPI(BaseAPI):
             包含股票详细信息的 DataFrame
 
         Example:
-            >>> client = LixingerClient()
-            >>> df = client.company.company.get_company(
-            ...     stock_codes=["000001", "600036"]
-            ... )
-            >>> print(df.head())
+            获取股票信息::
+
+                from lixinger import AsyncLixingerClient
+
+                async with AsyncLixingerClient() as client:
+                    df = await client.company.company.get_company(
+                        stock_codes=["000001", "600036"]
+                    )
+                    print(df)
 
         """
         payload: dict[str, Any] = {}

lixinger/api/cn/company/dividend.py

@@ -14,27 +14,47 @@ class DividendAPI(BaseAPI):
     async def get_dividend(
         self,
         stock_code: str,
-        start_date: str | None = None,
+        start_date: str,
         end_date: str | None = None,
+        limit: int | None = None,
     ) -> pd.DataFrame:
         """获取分红数据.
 
         API Endpoint: /cn/company/dividend
         API Method: POST
+        Documentation: https://www.lixinger.com/open/api/doc?api-key=cn/company/dividend
 
         Args:
             stock_code: 股票代码
-            start_date: 开始日期 (YYYY-MM-DD)
-            end_date: 结束日期 (YYYY-MM-DD)
+            start_date: 开始日期 (YYYY-MM-DD), 必填。起始时间和结束时间间隔不超过10年
+            end_date: 结束日期 (YYYY-MM-DD), 可选。默认值是上周一
+            limit: 返回最近数据的数量, 可选
+
+        Returns:
+            包含分红数据的 DataFrame
+
+        Example:
+            获取分红数据::
+
+                from lixinger import AsyncLixingerClient
+
+                async with AsyncLixingerClient() as client:
+                    df = await client.company.dividend.get_dividend(
+                        stock_code="600036",
+                        start_date="2023-01-01",
+                        end_date="2024-01-01"
+                    )
+                    print(df)
 
         """
         payload: dict[str, Any] = {
             "stockCode": stock_code,
+            "startDate": start_date,
         }
-        if start_date is not None:
-            payload["startDate"] = start_date
         if end_date is not None:
             payload["endDate"] = end_date
+        if limit is not None:
+            payload["limit"] = limit
 
         data = await self._request("POST", "/cn/company/dividend", json=payload)
         for item in data:
@@ -49,19 +69,25 @@ _api_instance = DividendAPI()
 @api
 async def get_dividend(
     stock_code: str,
-    start_date: str | None = None,
+    start_date: str,
     end_date: str | None = None,
+    limit: int | None = None,
 ) -> pd.DataFrame:
     """获取分红数据.
 
     Args:
         stock_code: 股票代码
-        start_date: 开始日期 (YYYY-MM-DD)
-        end_date: 结束日期 (YYYY-MM-DD)
+        start_date: 开始日期 (YYYY-MM-DD), 必填。起始时间和结束时间间隔不超过10年
+        end_date: 结束日期 (YYYY-MM-DD), 可选。默认值是上周一
+        limit: 返回最近数据的数量, 可选
+
+    Returns:
+        包含分红数据的 DataFrame
 
     """
     return await _api_instance.get_dividend(
         stock_code=stock_code,
         start_date=start_date,
         end_date=end_date,
+        limit=limit,
     )

lixinger/api/cn/company/equity_change.py

@@ -34,13 +34,17 @@ class EquityChangeAPI(BaseAPI):
             包含股本变动信息的 DataFrame
 
         Example:
-            >>> client = LixingerClient()
-            >>> df = client.company.equity_change.get_equity_change(
-            ...     stock_code="000001",
-            ...     start_date="2023-01-01",
-            ...     end_date="2023-12-31"
-            ... )
-            >>> print(df.head())
+            获取股本变动信息::
+
+                from lixinger import AsyncLixingerClient
+
+                async with AsyncLixingerClient() as client:
+                    df = await client.company.equity_change.get_equity_change(
+                        stock_code="000001",
+                        start_date="2023-01-01",
+                        end_date="2023-12-31"
+                    )
+                    print(df)
 
         """
         payload: dict[str, Any] = {

lixinger/api/cn/company/fundamental/__init__.py

@@ -0,0 +1,47 @@
+"""Fundamental data APIs.
+
+This module provides access to fundamental data APIs for different types of companies:
+- Non-financial companies (非金融企业)
+- Banks (银行)
+- Insurance companies (保险)
+- Securities companies (证券)
+- Other financial companies (其他金融)
+
+Each company type has its own dedicated API endpoint and data model.
+"""
+
+from lixinger.api.cn.company.fundamental.bank import (
+    BankFundamentalAPI,
+    get_bank_fundamental,
+)
+from lixinger.api.cn.company.fundamental.insurance import (
+    InsuranceFundamentalAPI,
+    get_insurance_fundamental,
+)
+from lixinger.api.cn.company.fundamental.non_financial import (
+    NonFinancialFundamentalAPI,
+    get_non_financial_fundamental,
+)
+from lixinger.api.cn.company.fundamental.other_financial import (
+    OtherFinancialFundamentalAPI,
+    get_other_financial_fundamental,
+)
+from lixinger.api.cn.company.fundamental.security import (
+    SecurityFundamentalAPI,
+    get_security_fundamental,
+)
+
+__all__ = [
+    # API Classes
+    "BankFundamentalAPI",
+    "InsuranceFundamentalAPI",
+    "NonFinancialFundamentalAPI",
+    "OtherFinancialFundamentalAPI",
+    "SecurityFundamentalAPI",
+    # Functional APIs
+    "get_bank_fundamental",
+    "get_insurance_fundamental",
+    "get_non_financial_fundamental",
+    "get_other_financial_fundamental",
+    "get_security_fundamental",
+]

lixinger/api/cn/company/fundamental/bank.py

@@ -0,0 +1,114 @@
+"""Bank fundamental data APIs."""
+
+from typing import Any
+
+import pandas as pd
+
+from lixinger.api.base import BaseAPI
+from lixinger.models.cn.company.fundamental.bank import BankFundamentalSchema
+from lixinger.utils.api import api
+from lixinger.utils.dataframe import get_response_df
+
+
+class BankFundamentalAPI(BaseAPI):
+    """Bank fundamental data APIs."""
+
+    async def get_bank_fundamental(
+        self,
+        stock_codes: list[str],
+        metrics: list[str],
+        date: str | None = None,
+        start_date: str | None = None,
+        end_date: str | None = None,
+    ) -> pd.DataFrame:
+        """获取银行基本面数据.
+
+        API Endpoint: /cn/company/fundamental/bank
+        API Method: POST
+        API Doc: https://www.lixinger.com/open/api/doc?api-key=cn/company/fundamental/bank
+
+        Args:
+            stock_codes: 股票代码列表
+            metrics: 指标列表
+            date: 日期 (YYYY-MM-DD), 与 start_date 二选一
+            start_date: 开始日期 (YYYY-MM-DD), 与 date 二选一
+            end_date: 结束日期 (YYYY-MM-DD), 可选
+
+        Returns:
+            包含银行基本面数据的 DataFrame
+
+        Example:
+            获取招商银行的估值指标::
+
+                from lixinger import AsyncLixingerClient
+
+                async with AsyncLixingerClient() as client:
+                    df = await client.company.fundamental.bank.get_bank_fundamental(
+                        stock_codes=["600036"],
+                        metrics=["pe_ttm", "pb", "roe"],
+                        start_date="2023-01-01",
+                        end_date="2023-12-31"
+                    )
+                    print(df)
+
+        """
+        payload: dict[str, Any] = {
+            "stockCodes": stock_codes,
+            "metricsList": metrics,
+        }
+        if date is not None:
+            payload["date"] = date
+        if start_date is not None:
+            payload["startDate"] = start_date
+        if end_date is not None:
+            payload["endDate"] = end_date
+
+        data = await self._request("POST", "/cn/company/fundamental/bank", json=payload)
+        return get_response_df(data, BankFundamentalSchema)
+
+
+# Functional API instance
+_api_instance = BankFundamentalAPI()
+
+
+@api
+async def get_bank_fundamental(
+    stock_codes: list[str],
+    metrics: list[str],
+    date: str | None = None,
+    start_date: str | None = None,
+    end_date: str | None = None,
+) -> pd.DataFrame:
+    """获取银行基本面数据.
+
+    Args:
+        stock_codes: 股票代码列表
+        metrics: 指标列表
+        date: 日期 (YYYY-MM-DD), 与 start_date 二选一
+        start_date: 开始日期 (YYYY-MM-DD), 与 date 二选一
+        end_date: 结束日期 (YYYY-MM-DD), 可选
+
+    Returns:
+        包含银行基本面数据的 DataFrame
+
+    Example:
+        获取招商银行的估值指标::
+
+            from lixinger import get_bank_fundamental
+
+            df = await get_bank_fundamental(
+                stock_codes=["600036"],
+                metrics=["pe_ttm", "pb", "roe"],
+                start_date="2023-01-01",
+                end_date="2023-12-31"
+            )
+            print(df)
+
+    """
+    return await _api_instance.get_bank_fundamental(
+        stock_codes=stock_codes,
+        metrics=metrics,
+        date=date,
+        start_date=start_date,
+        end_date=end_date,
+    )

lixinger/api/cn/company/fundamental/insurance.py

@@ -0,0 +1,114 @@
+"""Insurance company fundamental data APIs."""
+
+from typing import Any
+
+import pandas as pd
+
+from lixinger.api.base import BaseAPI
+from lixinger.models.cn.company.fundamental.insurance import InsuranceFundamentalSchema
+from lixinger.utils.api import api
+from lixinger.utils.dataframe import get_response_df
+
+
+class InsuranceFundamentalAPI(BaseAPI):
+    """Insurance company fundamental data APIs."""
+
+    async def get_insurance_fundamental(
+        self,
+        stock_codes: list[str],
+        metrics: list[str],
+        date: str | None = None,
+        start_date: str | None = None,
+        end_date: str | None = None,
+    ) -> pd.DataFrame:
+        """获取保险企业基本面数据.
+
+        API Endpoint: /cn/company/fundamental/insurance
+        API Method: POST
+        API Doc: https://www.lixinger.com/open/api/doc?api-key=cn/company/fundamental/insurance
+
+        Args:
+            stock_codes: 股票代码列表
+            metrics: 指标列表
+            date: 日期 (YYYY-MM-DD), 与 start_date 二选一
+            start_date: 开始日期 (YYYY-MM-DD), 与 date 二选一
+            end_date: 结束日期 (YYYY-MM-DD), 可选
+
+        Returns:
+            包含保险企业基本面数据的 DataFrame
+
+        Example:
+            获取中国平安的估值指标::
+
+                from lixinger import AsyncLixingerClient
+
+                async with AsyncLixingerClient() as client:
+                    df = await client.company.fundamental.insurance.get_insurance_fundamental(
+                        stock_codes=["601318"],
+                        metrics=["pe_ttm", "pb"],
+                        start_date="2023-01-01",
+                        end_date="2023-12-31"
+                    )
+                    print(df)
+
+        """
+        payload: dict[str, Any] = {
+            "stockCodes": stock_codes,
+            "metricsList": metrics,
+        }
+        if date is not None:
+            payload["date"] = date
+        if start_date is not None:
+            payload["startDate"] = start_date
+        if end_date is not None:
+            payload["endDate"] = end_date
+
+        data = await self._request("POST", "/cn/company/fundamental/insurance", json=payload)
+        return get_response_df(data, InsuranceFundamentalSchema)
+
+
+# Functional API instance
+_api_instance = InsuranceFundamentalAPI()
+
+
+@api
+async def get_insurance_fundamental(
+    stock_codes: list[str],
+    metrics: list[str],
+    date: str | None = None,
+    start_date: str | None = None,
+    end_date: str | None = None,
+) -> pd.DataFrame:
+    """获取保险企业基本面数据.
+
+    Args:
+        stock_codes: 股票代码列表
+        metrics: 指标列表
+        date: 日期 (YYYY-MM-DD), 与 start_date 二选一
+        start_date: 开始日期 (YYYY-MM-DD), 与 date 二选一
+        end_date: 结束日期 (YYYY-MM-DD), 可选
+
+    Returns:
+        包含保险企业基本面数据的 DataFrame
+
+    Example:
+        获取中国平安的估值指标::
+
+            from lixinger import get_insurance_fundamental
+
+            df = await get_insurance_fundamental(
+                stock_codes=["601318"],
+                metrics=["pe_ttm", "pb"],
+                start_date="2023-01-01",
+                end_date="2023-12-31"
+            )
+            print(df)
+
+    """
+    return await _api_instance.get_insurance_fundamental(
+        stock_codes=stock_codes,
+        metrics=metrics,
+        date=date,
+        start_date=start_date,
+        end_date=end_date,
+    )

lixinger/api/cn/company/fundamental/non_financial.py

@@ -0,0 +1,114 @@
+"""Non-financial company fundamental data APIs."""
+
+from typing import Any
+
+import pandas as pd
+
+from lixinger.api.base import BaseAPI
+from lixinger.models.cn.company.fundamental.non_financial import NonFinancialFundamentalSchema
+from lixinger.utils.api import api
+from lixinger.utils.dataframe import get_response_df
+
+
+class NonFinancialFundamentalAPI(BaseAPI):
+    """Non-financial company fundamental data APIs."""
+
+    async def get_non_financial_fundamental(
+        self,
+        stock_codes: list[str],
+        metrics: list[str],
+        date: str | None = None,
+        start_date: str | None = None,
+        end_date: str | None = None,
+    ) -> pd.DataFrame:
+        """获取非金融企业基本面数据.
+
+        API Endpoint: /cn/company/fundamental/non_financial
+        API Method: POST
+        API Doc: https://www.lixinger.com/open/api/doc?api-key=cn/company/fundamental/non_financial
+
+        Args:
+            stock_codes: 股票代码列表
+            metrics: 指标列表
+            date: 日期 (YYYY-MM-DD), 与 start_date 二选一
+            start_date: 开始日期 (YYYY-MM-DD), 与 date 二选一
+            end_date: 结束日期 (YYYY-MM-DD), 可选
+
+        Returns:
+            包含非金融企业基本面数据的 DataFrame
+
+        Example:
+            获取贵州茅台的估值指标::
+
+                from lixinger import AsyncLixingerClient
+
+                async with AsyncLixingerClient() as client:
+                    df = await client.company.fundamental.non_financial.get_non_financial_fundamental(
+                        stock_codes=["600519"],
+                        metrics=["pe_ttm", "pb", "ps_ttm"],
+                        start_date="2023-01-01",
+                        end_date="2023-12-31"
+                    )
+                    print(df)
+
+        """
+        payload: dict[str, Any] = {
+            "stockCodes": stock_codes,
+            "metricsList": metrics,
+        }
+        if date is not None:
+            payload["date"] = date
+        if start_date is not None:
+            payload["startDate"] = start_date
+        if end_date is not None:
+            payload["endDate"] = end_date
+
+        data = await self._request("POST", "/cn/company/fundamental/non_financial", json=payload)
+        return get_response_df(data, NonFinancialFundamentalSchema)
+
+
+# Functional API instance
+_api_instance = NonFinancialFundamentalAPI()
+
+
+@api
+async def get_non_financial_fundamental(
+    stock_codes: list[str],
+    metrics: list[str],
+    date: str | None = None,
+    start_date: str | None = None,
+    end_date: str | None = None,
+) -> pd.DataFrame:
+    """获取非金融企业基本面数据.
+
+    Args:
+        stock_codes: 股票代码列表
+        metrics: 指标列表
+        date: 日期 (YYYY-MM-DD), 与 start_date 二选一
+        start_date: 开始日期 (YYYY-MM-DD), 与 date 二选一
+        end_date: 结束日期 (YYYY-MM-DD), 可选
+
+    Returns:
+        包含非金融企业基本面数据的 DataFrame
+
+    Example:
+        获取贵州茅台的估值指标::
+
+            from lixinger import get_non_financial_fundamental
+
+            df = await get_non_financial_fundamental(
+                stock_codes=["600519"],
+                metrics=["pe_ttm", "pb", "ps_ttm"],
+                start_date="2023-01-01",
+                end_date="2023-12-31"
+            )
+            print(df)
+
+    """
+    return await _api_instance.get_non_financial_fundamental(
+        stock_codes=stock_codes,
+        metrics=metrics,
+        date=date,
+        start_date=start_date,
+        end_date=end_date,
+    )

lixinger/api/cn/company/fundamental/other_financial.py

@@ -0,0 +1,114 @@
+"""Other financial company fundamental data APIs."""
+
+from typing import Any
+
+import pandas as pd
+
+from lixinger.api.base import BaseAPI
+from lixinger.models.cn.company.fundamental.other_financial import OtherFinancialFundamentalSchema
+from lixinger.utils.api import api
+from lixinger.utils.dataframe import get_response_df
+
+
+class OtherFinancialFundamentalAPI(BaseAPI):
+    """Other financial company fundamental data APIs."""
+
+    async def get_other_financial_fundamental(
+        self,
+        stock_codes: list[str],
+        metrics: list[str],
+        date: str | None = None,
+        start_date: str | None = None,
+        end_date: str | None = None,
+    ) -> pd.DataFrame:
+        """获取其他金融企业基本面数据.
+
+        API Endpoint: /cn/company/fundamental/other_financial
+        API Method: POST
+        API Doc: https://www.lixinger.com/open/api/doc?api-key=cn/company/fundamental/other_financial
+
+        Args:
+            stock_codes: 股票代码列表
+            metrics: 指标列表
+            date: 日期 (YYYY-MM-DD), 与 start_date 二选一
+            start_date: 开始日期 (YYYY-MM-DD), 与 date 二选一
+            end_date: 结束日期 (YYYY-MM-DD), 可选
+
+        Returns:
+            包含其他金融企业基本面数据的 DataFrame
+
+        Example:
+            获取其他金融企业的估值指标::
+
+                from lixinger import AsyncLixingerClient
+
+                async with AsyncLixingerClient() as client:
+                    df = await client.company.fundamental.other_financial.get_other_financial_fundamental(
+                        stock_codes=["600999"],
+                        metrics=["pe_ttm", "pb"],
+                        start_date="2023-01-01",
+                        end_date="2023-12-31"
+                    )
+                    print(df)
+
+        """
+        payload: dict[str, Any] = {
+            "stockCodes": stock_codes,
+            "metricsList": metrics,
+        }
+        if date is not None:
+            payload["date"] = date
+        if start_date is not None:
+            payload["startDate"] = start_date
+        if end_date is not None:
+            payload["endDate"] = end_date
+
+        data = await self._request("POST", "/cn/company/fundamental/other_financial", json=payload)
+        return get_response_df(data, OtherFinancialFundamentalSchema)
+
+
+# Functional API instance
+_api_instance = OtherFinancialFundamentalAPI()
+
+
+@api
+async def get_other_financial_fundamental(
+    stock_codes: list[str],
+    metrics: list[str],
+    date: str | None = None,
+    start_date: str | None = None,
+    end_date: str | None = None,
+) -> pd.DataFrame:
+    """获取其他金融企业基本面数据.
+
+    Args:
+        stock_codes: 股票代码列表
+        metrics: 指标列表
+        date: 日期 (YYYY-MM-DD), 与 start_date 二选一
+        start_date: 开始日期 (YYYY-MM-DD), 与 date 二选一
+        end_date: 结束日期 (YYYY-MM-DD), 可选
+
+    Returns:
+        包含其他金融企业基本面数据的 DataFrame
+
+    Example:
+        获取其他金融企业的估值指标::
+
+            from lixinger import get_other_financial_fundamental
+
+            df = await get_other_financial_fundamental(
+                stock_codes=["600999"],
+                metrics=["pe_ttm", "pb"],
+                start_date="2023-01-01",
+                end_date="2023-12-31"
+            )
+            print(df)
+
+    """
+    return await _api_instance.get_other_financial_fundamental(
+        stock_codes=stock_codes,
+        metrics=metrics,
+        date=date,
+        start_date=start_date,
+        end_date=end_date,
+    )