lixinger-python 0.3.6__py3-none-any.whl → 0.3.8__py3-none-any.whl

lixinger/__init__.py

@@ -1,6 +1,12 @@
 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.fs import (
+    get_bank_statements,
+    get_insurance_statements,
+    get_non_financial_statements,
+    get_other_financial_statements,
+    get_security_statements,
+)
 from lixinger.api.cn.company.fundamental import (
     get_bank_fundamental,
     get_insurance_fundamental,
@@ -25,7 +31,11 @@ from lixinger.api.cn.index import (
     get_constituent_weightings,
     get_constituents,
     get_index,
+    get_index_bank_statements,
     get_index_fundamental,
+    get_index_hybrid_statements,
+    get_index_non_financial_statements,
+    get_index_security_statements,
     get_tracking_fund,
 )
 from lixinger.api.cn.index import (
@@ -69,9 +79,18 @@ __all__ = [
     "get_index_candlestick",
     "get_index_drawdown",
     "get_non_financial_statements",
+    "get_bank_statements",
+    "get_insurance_statements",
+    "get_security_statements",
+    "get_other_financial_statements",
     "get_non_financial_fundamental",
     "get_bank_fundamental",
     "get_insurance_fundamental",
     "get_security_fundamental",
     "get_other_financial_fundamental",
+    # Index financial statements
+    "get_index_non_financial_statements",
+    "get_index_bank_statements",
+    "get_index_security_statements",
+    "get_index_hybrid_statements",
 ]

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

@@ -1,5 +1,46 @@
-"""Financial statement APIs."""
+"""Financial statement APIs.
 
-from lixinger.api.cn.company.fs.non_financial import get_non_financial_statements
+This module provides access to company financial statement APIs by company type:
 
-__all__ = ["get_non_financial_statements"]
+- non_financial: Non-financial companies (非金融企业)
+- bank: Banks (银行)
+- insurance: Insurance companies (保险)
+- security: Securities companies (证券)
+- other_financial: Other financial companies (租赁、消费金融等)
+"""
+
+from lixinger.api.cn.company.fs.bank import (
+    BankStatementAPI,
+    get_bank_statements,
+)
+from lixinger.api.cn.company.fs.insurance import (
+    InsuranceStatementAPI,
+    get_insurance_statements,
+)
+from lixinger.api.cn.company.fs.non_financial import (
+    NonFinancialStatementAPI,
+    get_non_financial_statements,
+)
+from lixinger.api.cn.company.fs.other_financial import (
+    OtherFinancialStatementAPI,
+    get_other_financial_statements,
+)
+from lixinger.api.cn.company.fs.security import (
+    SecurityStatementAPI,
+    get_security_statements,
+)
+
+__all__ = [
+    # API Classes
+    "BankStatementAPI",
+    "InsuranceStatementAPI",
+    "NonFinancialStatementAPI",
+    "OtherFinancialStatementAPI",
+    "SecurityStatementAPI",
+    # Functional APIs
+    "get_bank_statements",
+    "get_insurance_statements",
+    "get_non_financial_statements",
+    "get_other_financial_statements",
+    "get_security_statements",
+]

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

@@ -0,0 +1,132 @@
+"""Bank financial statement APIs."""
+
+from typing import Any
+
+import pandas as pd
+
+from lixinger.api.base import BaseAPI
+from lixinger.models.cn.company.fs.bank import BankStatementSchema
+from lixinger.utils.api import api
+from lixinger.utils.dataframe import get_response_df
+from lixinger.utils.dict import flatten_dict
+
+
+class BankStatementAPI(BaseAPI):
+    """Bank financial statement APIs."""
+
+    async def get_bank_statements(  # noqa: PLR0913
+        self,
+        stock_codes: list[str],
+        metrics: list[str],
+        date: str | None = None,
+        start_date: str | None = None,
+        end_date: str | None = None,
+        limit: int | None = None,
+    ) -> pd.DataFrame:
+        """获取A股上市银行的财务报表数据.
+
+        API Endpoint: /cn/company/fs/bank
+        API Method: POST
+        API Doc: https://www.lixinger.com/open/api/doc?api-key=cn/company/fs/bank
+
+        获取A股上市银行的财务报表数据，包括利润表、资产负债表、现金流量表、
+        正常财务指标以及银行特有财务指标（净息差、净利差、资本充足率、
+        不良率、拨贷比等）。
+
+        Args:
+            stock_codes: 股票代码列表，长度 >=1 且 <=100。当传入 start_date
+                时只能传入一个股票代码。
+            metrics: 指标列表，格式为
+                ``[granularity].[tableName].[fieldName].[expressionCalculateType]``，
+                例如 ``"q.ps.oi.t"``。当 stock_codes 长度大于 1 时最多 48 个
+                指标；等于 1 时最多 128 个指标。
+            date: 日期 (YYYY-MM-DD)，与 start_date 二选一。支持 ``"latest"``。
+            start_date: 开始日期 (YYYY-MM-DD)，与 date 二选一。
+            end_date: 结束日期 (YYYY-MM-DD)，可选，默认上周一。
+            limit: 返回最近数据的数量，仅在 date range 请求下生效。
+
+        Returns:
+            包含A股银行财务报表数据的 DataFrame。
+
+        Example:
+            获取民生银行和工商银行的营业收入::
+
+                from lixinger import AsyncLixingerClient
+
+                async with AsyncLixingerClient() as client:
+                    df = await client.cn_company.fs.bank.get_bank_statements(
+                        stock_codes=["600016", "601398"],
+                        metrics=["q.ps.oi.t"],
+                        date="2026-03-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
+        if limit is not None:
+            payload["limit"] = limit
+
+        data = await self._request("POST", "/cn/company/fs/bank", json=payload)
+
+        # Flatten nested metrics (e.g. {"q": {"ps": {"oi": {"t": ...}}}})
+        flattened_data = [flatten_dict(item) for item in data]
+
+        return get_response_df(flattened_data, BankStatementSchema)
+
+
+# Functional API instance
+_api_instance = BankStatementAPI()
+
+
+@api
+async def get_bank_statements(  # noqa: PLR0913
+    stock_codes: list[str],
+    metrics: list[str],
+    date: str | None = None,
+    start_date: str | None = None,
+    end_date: str | None = None,
+    limit: int | None = None,
+) -> pd.DataFrame:
+    """获取A股上市银行的财务报表数据.
+
+    Args:
+        stock_codes: 股票代码列表。
+        metrics: 指标列表。
+        date: 日期 (YYYY-MM-DD)，与 start_date 二选一。
+        start_date: 开始日期 (YYYY-MM-DD)，与 date 二选一。
+        end_date: 结束日期 (YYYY-MM-DD)，可选。
+        limit: 返回最近数据的数量，仅在 date range 请求下生效。
+
+    Returns:
+        包含A股银行财务报表数据的 DataFrame。
+
+    Example:
+        获取民生银行的营业收入::
+
+            from lixinger import get_bank_statements
+
+            df = await get_bank_statements(
+                stock_codes=["600016"],
+                metrics=["q.ps.oi.t"],
+                date="2026-03-31",
+            )
+            print(df)
+
+    """
+    return await _api_instance.get_bank_statements(
+        stock_codes=stock_codes,
+        metrics=metrics,
+        date=date,
+        start_date=start_date,
+        end_date=end_date,
+        limit=limit,
+    )

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

@@ -0,0 +1,132 @@
+"""Insurance financial statement APIs."""
+
+from typing import Any
+
+import pandas as pd
+
+from lixinger.api.base import BaseAPI
+from lixinger.models.cn.company.fs.insurance import InsuranceStatementSchema
+from lixinger.utils.api import api
+from lixinger.utils.dataframe import get_response_df
+from lixinger.utils.dict import flatten_dict
+
+
+class InsuranceStatementAPI(BaseAPI):
+    """Insurance financial statement APIs."""
+
+    async def get_insurance_statements(  # noqa: PLR0913
+        self,
+        stock_codes: list[str],
+        metrics: list[str],
+        date: str | None = None,
+        start_date: str | None = None,
+        end_date: str | None = None,
+        limit: int | None = None,
+    ) -> pd.DataFrame:
+        """获取A股保险公司的财务报表数据.
+
+        API Endpoint: /cn/company/fs/insurance
+        API Method: POST
+        API Doc: https://www.lixinger.com/open/api/doc?api-key=cn/company/fs/insurance
+
+        获取A股保险公司的财务报表数据，包括利润表、资产负债表、现金流量表、
+        正常财务指标以及保险公司特有财务指标（内含价值、新业务价值、
+        核心偿付能力充足率、综合偿付能力充足率等）。
+
+        Args:
+            stock_codes: 股票代码列表，长度 >=1 且 <=100。当传入 start_date
+                时只能传入一个股票代码。
+            metrics: 指标列表，格式为
+                ``[granularity].[tableName].[fieldName].[expressionCalculateType]``，
+                例如 ``"q.ps.toi.t"``。当 stock_codes 长度大于 1 时最多 48 个
+                指标；等于 1 时最多 128 个指标。
+            date: 日期 (YYYY-MM-DD)，与 start_date 二选一。支持 ``"latest"``。
+            start_date: 开始日期 (YYYY-MM-DD)，与 date 二选一。
+            end_date: 结束日期 (YYYY-MM-DD)，可选，默认上周一。
+            limit: 返回最近数据的数量，仅在 date range 请求下生效。
+
+        Returns:
+            包含A股保险公司财务报表数据的 DataFrame。
+
+        Example:
+            获取中国平安的营业总收入::
+
+                from lixinger import AsyncLixingerClient
+
+                async with AsyncLixingerClient() as client:
+                    df = await client.cn_company.fs.insurance.get_insurance_statements(
+                        stock_codes=["601318"],
+                        metrics=["q.ps.toi.t"],
+                        date="2026-03-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
+        if limit is not None:
+            payload["limit"] = limit
+
+        data = await self._request("POST", "/cn/company/fs/insurance", json=payload)
+
+        # Flatten nested metrics (e.g. {"q": {"ps": {"toi": {"t": ...}}}})
+        flattened_data = [flatten_dict(item) for item in data]
+
+        return get_response_df(flattened_data, InsuranceStatementSchema)
+
+
+# Functional API instance
+_api_instance = InsuranceStatementAPI()
+
+
+@api
+async def get_insurance_statements(  # noqa: PLR0913
+    stock_codes: list[str],
+    metrics: list[str],
+    date: str | None = None,
+    start_date: str | None = None,
+    end_date: str | None = None,
+    limit: int | None = None,
+) -> pd.DataFrame:
+    """获取A股保险公司的财务报表数据.
+
+    Args:
+        stock_codes: 股票代码列表。
+        metrics: 指标列表。
+        date: 日期 (YYYY-MM-DD)，与 start_date 二选一。
+        start_date: 开始日期 (YYYY-MM-DD)，与 date 二选一。
+        end_date: 结束日期 (YYYY-MM-DD)，可选。
+        limit: 返回最近数据的数量，仅在 date range 请求下生效。
+
+    Returns:
+        包含A股保险公司财务报表数据的 DataFrame。
+
+    Example:
+        获取中国平安的营业总收入::
+
+            from lixinger import get_insurance_statements
+
+            df = await get_insurance_statements(
+                stock_codes=["601318"],
+                metrics=["q.ps.toi.t"],
+                date="2026-03-31",
+            )
+            print(df)
+
+    """
+    return await _api_instance.get_insurance_statements(
+        stock_codes=stock_codes,
+        metrics=metrics,
+        date=date,
+        start_date=start_date,
+        end_date=end_date,
+        limit=limit,
+    )

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

@@ -14,13 +14,14 @@ from lixinger.utils.dict import flatten_dict
 class NonFinancialStatementAPI(BaseAPI):
     """Non-financial statement APIs."""
 
-    async def get_non_financial_statements(
+    async def get_non_financial_statements(  # noqa: PLR0913
         self,
         stock_codes: list[str],
         metrics: list[str],
         date: str | None = None,
         start_date: str | None = None,
         end_date: str | None = None,
+        limit: int | None = None,
     ) -> pd.DataFrame:
         """获取非金融企业财务报表数据.
 
@@ -34,6 +35,7 @@ class NonFinancialStatementAPI(BaseAPI):
             date: 日期 (YYYY-MM-DD), 与 startDate 二选一
             start_date: 开始日期 (YYYY-MM-DD), 与 date 二选一
             end_date: 结束日期 (YYYY-MM-DD), 可选
+            limit: 返回最近数据的数量，仅在 date range 请求下生效
 
         """
         payload: dict[str, Any] = {
@@ -46,6 +48,8 @@ class NonFinancialStatementAPI(BaseAPI):
             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/fs/non_financial", json=payload)
 
@@ -60,12 +64,13 @@ _api_instance = NonFinancialStatementAPI()
 
 
 @api
-async def get_non_financial_statements(
+async def get_non_financial_statements(  # noqa: PLR0913
     stock_codes: list[str],
     metrics: list[str],
     date: str | None = None,
     start_date: str | None = None,
     end_date: str | None = None,
+    limit: int | None = None,
 ) -> pd.DataFrame:
     """获取非金融企业财务报表数据."""
     return await _api_instance.get_non_financial_statements(
@@ -74,4 +79,5 @@ async def get_non_financial_statements(
         date=date,
         start_date=start_date,
         end_date=end_date,
+        limit=limit,
     )

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

@@ -0,0 +1,131 @@
+"""Other financial company financial statement APIs."""
+
+from typing import Any
+
+import pandas as pd
+
+from lixinger.api.base import BaseAPI
+from lixinger.models.cn.company.fs.other_financial import OtherFinancialStatementSchema
+from lixinger.utils.api import api
+from lixinger.utils.dataframe import get_response_df
+from lixinger.utils.dict import flatten_dict
+
+
+class OtherFinancialStatementAPI(BaseAPI):
+    """Other financial company financial statement APIs."""
+
+    async def get_other_financial_statements(  # noqa: PLR0913
+        self,
+        stock_codes: list[str],
+        metrics: list[str],
+        date: str | None = None,
+        start_date: str | None = None,
+        end_date: str | None = None,
+        limit: int | None = None,
+    ) -> pd.DataFrame:
+        """获取A股其他金融公司（租赁、消费金融等）的财务报表数据.
+
+        API Endpoint: /cn/company/fs/other_financial
+        API Method: POST
+        API Doc: https://www.lixinger.com/open/api/doc?api-key=cn/company/fs/other_financial
+
+        获取A股其他金融公司（租赁、消费金融等）的财务报表数据，包括利润表、
+        资产负债表、现金流量表以及各类财务指标。
+
+        Args:
+            stock_codes: 股票代码列表，长度 >=1 且 <=100。当传入 start_date
+                时只能传入一个股票代码。
+            metrics: 指标列表，格式为
+                ``[granularity].[tableName].[fieldName].[expressionCalculateType]``，
+                例如 ``"q.ps.toi.t"``。当 stock_codes 长度大于 1 时最多 48 个
+                指标；等于 1 时最多 128 个指标。
+            date: 日期 (YYYY-MM-DD)，与 start_date 二选一。支持 ``"latest"``。
+            start_date: 开始日期 (YYYY-MM-DD)，与 date 二选一。
+            end_date: 结束日期 (YYYY-MM-DD)，可选，默认上周一。
+            limit: 返回最近数据的数量，仅在 date range 请求下生效。
+
+        Returns:
+            包含A股其他金融公司财务报表数据的 DataFrame。
+
+        Example:
+            获取江苏租赁的营业总收入::
+
+                from lixinger import AsyncLixingerClient
+
+                async with AsyncLixingerClient() as client:
+                    df = await client.cn_company.fs.other_financial.get_other_financial_statements(
+                        stock_codes=["600901"],
+                        metrics=["q.ps.toi.t"],
+                        date="2026-03-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
+        if limit is not None:
+            payload["limit"] = limit
+
+        data = await self._request("POST", "/cn/company/fs/other_financial", json=payload)
+
+        # Flatten nested metrics (e.g. {"q": {"ps": {"toi": {"t": ...}}}})
+        flattened_data = [flatten_dict(item) for item in data]
+
+        return get_response_df(flattened_data, OtherFinancialStatementSchema)
+
+
+# Functional API instance
+_api_instance = OtherFinancialStatementAPI()
+
+
+@api
+async def get_other_financial_statements(  # noqa: PLR0913
+    stock_codes: list[str],
+    metrics: list[str],
+    date: str | None = None,
+    start_date: str | None = None,
+    end_date: str | None = None,
+    limit: int | None = None,
+) -> pd.DataFrame:
+    """获取A股其他金融公司（租赁、消费金融等）的财务报表数据.
+
+    Args:
+        stock_codes: 股票代码列表。
+        metrics: 指标列表。
+        date: 日期 (YYYY-MM-DD)，与 start_date 二选一。
+        start_date: 开始日期 (YYYY-MM-DD)，与 date 二选一。
+        end_date: 结束日期 (YYYY-MM-DD)，可选。
+        limit: 返回最近数据的数量，仅在 date range 请求下生效。
+
+    Returns:
+        包含A股其他金融公司财务报表数据的 DataFrame。
+
+    Example:
+        获取江苏租赁的营业总收入::
+
+            from lixinger import get_other_financial_statements
+
+            df = await get_other_financial_statements(
+                stock_codes=["600901"],
+                metrics=["q.ps.toi.t"],
+                date="2026-03-31",
+            )
+            print(df)
+
+    """
+    return await _api_instance.get_other_financial_statements(
+        stock_codes=stock_codes,
+        metrics=metrics,
+        date=date,
+        start_date=start_date,
+        end_date=end_date,
+        limit=limit,
+    )

lixinger/api/cn/company/fs/security.py

@@ -0,0 +1,132 @@
+"""Security (securities firm) financial statement APIs."""
+
+from typing import Any
+
+import pandas as pd
+
+from lixinger.api.base import BaseAPI
+from lixinger.models.cn.company.fs.security import SecurityStatementSchema
+from lixinger.utils.api import api
+from lixinger.utils.dataframe import get_response_df
+from lixinger.utils.dict import flatten_dict
+
+
+class SecurityStatementAPI(BaseAPI):
+    """Security (securities firm) financial statement APIs."""
+
+    async def get_security_statements(  # noqa: PLR0913
+        self,
+        stock_codes: list[str],
+        metrics: list[str],
+        date: str | None = None,
+        start_date: str | None = None,
+        end_date: str | None = None,
+        limit: int | None = None,
+    ) -> pd.DataFrame:
+        """获取A股证券公司的财务报表数据.
+
+        API Endpoint: /cn/company/fs/security
+        API Method: POST
+        API Doc: https://www.lixinger.com/open/api/doc?api-key=cn/company/fs/security
+
+        获取A股证券公司的财务报表数据，包括利润表、资产负债表、现金流量表、
+        正常财务指标以及证券公司特有财务指标（净资本、风险覆盖率、
+        资本杠杆率、流动性覆盖率、净稳定资金率等）。
+
+        Args:
+            stock_codes: 股票代码列表，长度 >=1 且 <=100。当传入 start_date
+                时只能传入一个股票代码。
+            metrics: 指标列表，格式为
+                ``[granularity].[tableName].[fieldName].[expressionCalculateType]``，
+                例如 ``"q.ps.toi.t"``。当 stock_codes 长度大于 1 时最多 48 个
+                指标；等于 1 时最多 128 个指标。
+            date: 日期 (YYYY-MM-DD)，与 start_date 二选一。支持 ``"latest"``。
+            start_date: 开始日期 (YYYY-MM-DD)，与 date 二选一。
+            end_date: 结束日期 (YYYY-MM-DD)，可选，默认上周一。
+            limit: 返回最近数据的数量，仅在 date range 请求下生效。
+
+        Returns:
+            包含A股证券公司财务报表数据的 DataFrame。
+
+        Example:
+            获取中信证券的营业总收入::
+
+                from lixinger import AsyncLixingerClient
+
+                async with AsyncLixingerClient() as client:
+                    df = await client.cn_company.fs.security.get_security_statements(
+                        stock_codes=["600030"],
+                        metrics=["q.ps.toi.t"],
+                        date="2026-03-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
+        if limit is not None:
+            payload["limit"] = limit
+
+        data = await self._request("POST", "/cn/company/fs/security", json=payload)
+
+        # Flatten nested metrics (e.g. {"q": {"ps": {"toi": {"t": ...}}}})
+        flattened_data = [flatten_dict(item) for item in data]
+
+        return get_response_df(flattened_data, SecurityStatementSchema)
+
+
+# Functional API instance
+_api_instance = SecurityStatementAPI()
+
+
+@api
+async def get_security_statements(  # noqa: PLR0913
+    stock_codes: list[str],
+    metrics: list[str],
+    date: str | None = None,
+    start_date: str | None = None,
+    end_date: str | None = None,
+    limit: int | None = None,
+) -> pd.DataFrame:
+    """获取A股证券公司的财务报表数据.
+
+    Args:
+        stock_codes: 股票代码列表。
+        metrics: 指标列表。
+        date: 日期 (YYYY-MM-DD)，与 start_date 二选一。
+        start_date: 开始日期 (YYYY-MM-DD)，与 date 二选一。
+        end_date: 结束日期 (YYYY-MM-DD)，可选。
+        limit: 返回最近数据的数量，仅在 date range 请求下生效。
+
+    Returns:
+        包含A股证券公司财务报表数据的 DataFrame。
+
+    Example:
+        获取中信证券的营业总收入::
+
+            from lixinger import get_security_statements
+
+            df = await get_security_statements(
+                stock_codes=["600030"],
+                metrics=["q.ps.toi.t"],
+                date="2026-03-31",
+            )
+            print(df)
+
+    """
+    return await _api_instance.get_security_statements(
+        stock_codes=stock_codes,
+        metrics=metrics,
+        date=date,
+        start_date=start_date,
+        end_date=end_date,
+        limit=limit,
+    )