lixinger-python 0.3.6__tar.gz → 0.3.7__tar.gz

{lixinger_python-0.3.6 → lixinger_python-0.3.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lixinger-python
-Version: 0.3.6
+Version: 0.3.7
 Summary: Python SDK for Lixinger Financial Data API
 Project-URL: Homepage, https://www.lixinger.com
 Project-URL: Documentation, https://www.lixinger.com/open/api/doc

{lixinger_python-0.3.6 → lixinger_python-0.3.7}/lixinger/__init__.py

@@ -25,7 +25,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 (
@@ -74,4 +78,9 @@ __all__ = [
     "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_python-0.3.6 → lixinger_python-0.3.7}/lixinger/api/cn/index/__init__.py

@@ -7,6 +7,16 @@ from lixinger.api.cn.index.constituent_weightings import (
 )
 from lixinger.api.cn.index.constituents import ConstituentsAPI, get_constituents
 from lixinger.api.cn.index.drawdown import DrawdownAPI, get_drawdown
+from lixinger.api.cn.index.fs import (
+    IndexBankStatementAPI,
+    IndexHybridStatementAPI,
+    IndexNonFinancialStatementAPI,
+    IndexSecurityStatementAPI,
+    get_index_bank_statements,
+    get_index_hybrid_statements,
+    get_index_non_financial_statements,
+    get_index_security_statements,
+)
 from lixinger.api.cn.index.fundamental import (
     IndexFundamentalAPI,
     get_index_fundamental,
@@ -29,4 +39,13 @@ __all__ = [
     "get_index_fundamental",
     "TrackingFundAPI",
     "get_tracking_fund",
+    # Index financial statements
+    "IndexBankStatementAPI",
+    "IndexHybridStatementAPI",
+    "IndexNonFinancialStatementAPI",
+    "IndexSecurityStatementAPI",
+    "get_index_bank_statements",
+    "get_index_hybrid_statements",
+    "get_index_non_financial_statements",
+    "get_index_security_statements",
 ]

lixinger_python-0.3.7/lixinger/api/cn/index/fs/__init__.py

@@ -0,0 +1,38 @@
+"""Index financial statement APIs.
+
+This module provides access to index financial statement APIs by index type:
+- Non-financial indices (非金融类指数)
+- Bank indices (银行类指数)
+- Security indices (证券类指数)
+- Hybrid indices (混合型指数)
+"""
+
+from lixinger.api.cn.index.fs.bank import (
+    IndexBankStatementAPI,
+    get_index_bank_statements,
+)
+from lixinger.api.cn.index.fs.hybrid import (
+    IndexHybridStatementAPI,
+    get_index_hybrid_statements,
+)
+from lixinger.api.cn.index.fs.non_financial import (
+    IndexNonFinancialStatementAPI,
+    get_index_non_financial_statements,
+)
+from lixinger.api.cn.index.fs.security import (
+    IndexSecurityStatementAPI,
+    get_index_security_statements,
+)
+
+__all__ = [
+    # API Classes
+    "IndexBankStatementAPI",
+    "IndexHybridStatementAPI",
+    "IndexNonFinancialStatementAPI",
+    "IndexSecurityStatementAPI",
+    # Functional APIs
+    "get_index_bank_statements",
+    "get_index_hybrid_statements",
+    "get_index_non_financial_statements",
+    "get_index_security_statements",
+]

lixinger_python-0.3.7/lixinger/api/cn/index/fs/bank.py

@@ -0,0 +1,130 @@
+"""Index bank statement APIs."""
+
+from typing import Any
+
+import pandas as pd
+
+from lixinger.api.base import BaseAPI
+from lixinger.models.cn.index.fs.bank import IndexBankStatementSchema
+from lixinger.utils.api import api
+from lixinger.utils.dataframe import get_response_df
+from lixinger.utils.dict import flatten_dict
+
+
+class IndexBankStatementAPI(BaseAPI):
+    """Index bank 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:
+        """获取银行类指数的财务报表数据.
+
+        API Endpoint: /cn/index/fs/bank
+        API Method: POST
+        API Doc: https://www.lixinger.com/open/api/doc?api-key=cn/index/fs/bank
+
+        获取银行类大陆指数（样本仅包含银行）的财务数据，包括利润表、
+        资产负债表、现金流量表、财务指标。
+
+        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:
+            包含银行类指数财务报表数据的 DataFrame。
+
+        Example:
+            获取中证银行指数的营业收入::
+
+                from lixinger import AsyncLixingerClient
+
+                async with AsyncLixingerClient() as client:
+                    df = await client.index.fs.bank.get_bank_statements(
+                        stock_codes=["399986"],
+                        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/index/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, IndexBankStatementSchema)
+
+
+# Functional API instance
+_api_instance = IndexBankStatementAPI()
+
+
+@api
+async def get_index_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:
+    """获取银行类指数的财务报表数据.
+
+    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:
+        包含银行类指数财务报表数据的 DataFrame。
+
+    Example:
+        获取中证银行指数的营业收入::
+
+            from lixinger import get_index_bank_statements
+
+            df = await get_index_bank_statements(
+                stock_codes=["399986"],
+                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_python-0.3.7/lixinger/api/cn/index/fs/hybrid.py

@@ -0,0 +1,130 @@
+"""Index hybrid statement APIs."""
+
+from typing import Any
+
+import pandas as pd
+
+from lixinger.api.base import BaseAPI
+from lixinger.models.cn.index.fs.hybrid import IndexHybridStatementSchema
+from lixinger.utils.api import api
+from lixinger.utils.dataframe import get_response_df
+from lixinger.utils.dict import flatten_dict
+
+
+class IndexHybridStatementAPI(BaseAPI):
+    """Index hybrid statement APIs."""
+
+    async def get_hybrid_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:
+        """获取混合型指数的财务报表数据.
+
+        API Endpoint: /cn/index/fs/hybrid
+        API Method: POST
+        API Doc: https://www.lixinger.com/open/api/doc?api-key=cn/index/fs/hybrid
+
+        获取混合型大陆指数（样本同时包含金融公司和非金融公司）的财务数据，
+        包括利润表、资产负债表、现金流量表、财务指标。
+
+        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:
+            包含混合型指数财务报表数据的 DataFrame。
+
+        Example:
+            获取上证 50 的营业总收入::
+
+                from lixinger import AsyncLixingerClient
+
+                async with AsyncLixingerClient() as client:
+                    df = await client.index.fs.hybrid.get_hybrid_statements(
+                        stock_codes=["000016"],
+                        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/index/fs/hybrid", json=payload)
+
+        # Flatten nested metrics
+        flattened_data = [flatten_dict(item) for item in data]
+
+        return get_response_df(flattened_data, IndexHybridStatementSchema)
+
+
+# Functional API instance
+_api_instance = IndexHybridStatementAPI()
+
+
+@api
+async def get_index_hybrid_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:
+    """获取混合型指数的财务报表数据.
+
+    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:
+        包含混合型指数财务报表数据的 DataFrame。
+
+    Example:
+        获取上证 50 的营业总收入::
+
+            from lixinger import get_index_hybrid_statements
+
+            df = await get_index_hybrid_statements(
+                stock_codes=["000016"],
+                metrics=["q.ps.toi.t"],
+                date="2026-03-31",
+            )
+            print(df)
+
+    """
+    return await _api_instance.get_hybrid_statements(
+        stock_codes=stock_codes,
+        metrics=metrics,
+        date=date,
+        start_date=start_date,
+        end_date=end_date,
+        limit=limit,
+    )

lixinger_python-0.3.7/lixinger/api/cn/index/fs/non_financial.py

@@ -0,0 +1,130 @@
+"""Index non-financial statement APIs."""
+
+from typing import Any
+
+import pandas as pd
+
+from lixinger.api.base import BaseAPI
+from lixinger.models.cn.index.fs.non_financial import IndexNonFinancialStatementSchema
+from lixinger.utils.api import api
+from lixinger.utils.dataframe import get_response_df
+from lixinger.utils.dict import flatten_dict
+
+
+class IndexNonFinancialStatementAPI(BaseAPI):
+    """Index non-financial statement APIs."""
+
+    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:
+        """获取非金融类指数的财务报表数据.
+
+        API Endpoint: /cn/index/fs/non_financial
+        API Method: POST
+        API Doc: https://www.lixinger.com/open/api/doc?api-key=cn/index/fs/non_financial
+
+        获取非金融类大陆指数（样本仅包含非金融公司）的财务数据，包括利润表、
+        资产负债表、现金流量表、财务指标。
+
+        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:
+            包含非金融类指数财务报表数据的 DataFrame。
+
+        Example:
+            获取中证白酒指数的营业总收入::
+
+                from lixinger import AsyncLixingerClient
+
+                async with AsyncLixingerClient() as client:
+                    df = await client.index.fs.non_financial.get_non_financial_statements(
+                        stock_codes=["000932"],
+                        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/index/fs/non_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, IndexNonFinancialStatementSchema)
+
+
+# Functional API instance
+_api_instance = IndexNonFinancialStatementAPI()
+
+
+@api
+async def get_index_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:
+    """获取非金融类指数的财务报表数据.
+
+    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:
+        包含非金融类指数财务报表数据的 DataFrame。
+
+    Example:
+        获取中证白酒指数的营业总收入::
+
+            from lixinger import get_index_non_financial_statements
+
+            df = await get_index_non_financial_statements(
+                stock_codes=["000932"],
+                metrics=["q.ps.toi.t"],
+                date="2026-03-31",
+            )
+            print(df)
+
+    """
+    return await _api_instance.get_non_financial_statements(
+        stock_codes=stock_codes,
+        metrics=metrics,
+        date=date,
+        start_date=start_date,
+        end_date=end_date,
+        limit=limit,
+    )

lixinger_python-0.3.7/lixinger/api/cn/index/fs/security.py

@@ -0,0 +1,130 @@
+"""Index security statement APIs."""
+
+from typing import Any
+
+import pandas as pd
+
+from lixinger.api.base import BaseAPI
+from lixinger.models.cn.index.fs.security import IndexSecurityStatementSchema
+from lixinger.utils.api import api
+from lixinger.utils.dataframe import get_response_df
+from lixinger.utils.dict import flatten_dict
+
+
+class IndexSecurityStatementAPI(BaseAPI):
+    """Index security 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:
+        """获取证券类指数的财务报表数据.
+
+        API Endpoint: /cn/index/fs/security
+        API Method: POST
+        API Doc: https://www.lixinger.com/open/api/doc?api-key=cn/index/fs/security
+
+        获取证券类大陆指数（样本仅包含证券公司）的财务数据，包括利润表、
+        资产负债表、现金流量表、财务指标。
+
+        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:
+            包含证券类指数财务报表数据的 DataFrame。
+
+        Example:
+            获取证券公司指数的营业总收入::
+
+                from lixinger import AsyncLixingerClient
+
+                async with AsyncLixingerClient() as client:
+                    df = await client.index.fs.security.get_security_statements(
+                        stock_codes=["399975"],
+                        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/index/fs/security", json=payload)
+
+        # Flatten nested metrics
+        flattened_data = [flatten_dict(item) for item in data]
+
+        return get_response_df(flattened_data, IndexSecurityStatementSchema)
+
+
+# Functional API instance
+_api_instance = IndexSecurityStatementAPI()
+
+
+@api
+async def get_index_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:
+    """获取证券类指数的财务报表数据.
+
+    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:
+        包含证券类指数财务报表数据的 DataFrame。
+
+    Example:
+        获取证券公司指数的营业总收入::
+
+            from lixinger import get_index_security_statements
+
+            df = await get_index_security_statements(
+                stock_codes=["399975"],
+                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,
+    )