From b4838d2c5fa3fc08fad087ea7e4c75ad2c41d718 Mon Sep 17 00:00:00 2001 From: linqi Date: Mon, 29 Jun 2026 16:13:53 +0800 Subject: [PATCH] =?UTF-8?q?=E6=8C=89=20ftshare-doc=20=E9=80=82=E9=85=8D=20?= =?UTF-8?q?SDK=20=E6=8E=A5=E5=8F=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 将endpoint 注册表拆分为 ftshare-doc 专题模块 - 将 apis mixin 按 ftshare-doc 分类对齐 - 默认 base_url 更新为 /gateway/ - 新增 stock_intraday_prices、stock_daec_stocks、stock_realtime_list 接口 - 重新生成 179 个接口的 API_REFERENCE 文档 - 版本更新为 0.1.1，并补充 CHANGELOG - 扩展 gateway URL 拼接和 path 参数接口测试 --- .gitignore | 6 + CHANGELOG.md | 7 + README.md | 20 +- docs/API_REFERENCE.md | 6240 +++++++---------- pyproject.toml | 2 +- src/ftshare/__init__.py | 4 +- src/ftshare/apis/__init__.py | 44 +- src/ftshare/apis/bond.py | 84 + src/ftshare/apis/economic.py | 150 +- src/ftshare/apis/etf.py | 5 +- src/ftshare/apis/finance.py | 450 -- .../apis/{global_index.py => forex.py} | 25 +- src/ftshare/apis/fund.py | 5 +- src/ftshare/apis/futures.py | 148 +- src/ftshare/apis/hk.py | 30 +- src/ftshare/apis/index.py | 230 +- .../apis/{goodwill.py => llm_corpus.py} | 107 +- src/ftshare/apis/market.py | 2352 ------- src/ftshare/apis/pledge.py | 170 - src/ftshare/apis/spot.py | 104 + src/ftshare/apis/stock.py | 2928 +++++++- .../apis/{corporate.py => unpublished.py} | 119 +- src/ftshare/apis/{holder.py => us.py} | 226 +- src/ftshare/base.py | 8 +- src/ftshare/client.py | 38 +- src/ftshare/config.py | 6 +- src/ftshare/endpoints.py | 1960 ------ src/ftshare/endpoints/__init__.py | 37 + src/ftshare/endpoints/bond.py | 22 + src/ftshare/endpoints/economic.py | 114 + src/ftshare/endpoints/etf.py | 64 + src/ftshare/endpoints/forex.py | 15 + src/ftshare/endpoints/fund.py | 44 + src/ftshare/endpoints/futures.py | 73 + src/ftshare/endpoints/hk.py | 107 + src/ftshare/endpoints/index.py | 67 + src/ftshare/endpoints/llm_corpus.py | 44 + src/ftshare/endpoints/spot.py | 22 + src/ftshare/endpoints/stock.py | 674 ++ src/ftshare/endpoints/types.py | 40 + src/ftshare/endpoints/unpublished.py | 39 + src/ftshare/endpoints/us.py | 76 + tests/test_client.py | 75 +- 43 files changed, 7853 insertions(+), 9128 deletions(-) create mode 100644 src/ftshare/apis/bond.py delete mode 100644 src/ftshare/apis/finance.py rename src/ftshare/apis/{global_index.py => forex.py} (57%) rename src/ftshare/apis/{goodwill.py => llm_corpus.py} (69%) delete mode 100644 src/ftshare/apis/market.py delete mode 100644 src/ftshare/apis/pledge.py create mode 100644 src/ftshare/apis/spot.py rename src/ftshare/apis/{corporate.py => unpublished.py} (71%) rename src/ftshare/apis/{holder.py => us.py} (65%) delete mode 100644 src/ftshare/endpoints.py create mode 100644 src/ftshare/endpoints/__init__.py create mode 100644 src/ftshare/endpoints/bond.py create mode 100644 src/ftshare/endpoints/economic.py create mode 100644 src/ftshare/endpoints/etf.py create mode 100644 src/ftshare/endpoints/forex.py create mode 100644 src/ftshare/endpoints/fund.py create mode 100644 src/ftshare/endpoints/futures.py create mode 100644 src/ftshare/endpoints/hk.py create mode 100644 src/ftshare/endpoints/index.py create mode 100644 src/ftshare/endpoints/llm_corpus.py create mode 100644 src/ftshare/endpoints/spot.py create mode 100644 src/ftshare/endpoints/stock.py create mode 100644 src/ftshare/endpoints/types.py create mode 100644 src/ftshare/endpoints/unpublished.py create mode 100644 src/ftshare/endpoints/us.py diff --git a/.gitignore b/.gitignore index 9759bad..d551051 100644 --- a/.gitignore +++ b/.gitignore @@ -34,6 +34,12 @@ htmlcov/ # Logs / runtime *.log +# Local API documentation checkout used to regenerate SDK metadata +ftshare-doc/ + +# Local SDK verification workspace; not shipped with package releases +sdk_smoke_test/ + # Secrets / env .env .env.local diff --git a/CHANGELOG.md b/CHANGELOG.md index c0e2769..454bcf3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [0.1.1] - 2026-06-29 + +### Changed +- Default `base_url` changed from `https://market.ft.tech/data/` to `https://market.ft.tech/gateway/`. +- Endpoint and API mixin registries are now split by `ftshare-doc/api-doc` topic. +- SDK coverage updated to 179 market-data endpoints. + ## [0.1.0] - 2026-06-23 ### Added diff --git a/README.md b/README.md index ba09420..7537281 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,13 @@ Agent 应用 # 面向最终用户的投研分析体验 ## 安装 -克隆仓库并以可编辑模式安装（含测试依赖）： +通过 PyPI 安装： + +```bash +pip install ftshare +``` + +本地开发时，克隆仓库并以可编辑模式安装（含测试依赖）： ```bash git clone git@github.com:ftshare-lab/ftshare-python-sdk.git @@ -110,23 +116,23 @@ with ft.market_api(timeout=20) as market: import ftshare as ft print(ft.BASE_URL) -# https://market.ft.tech/data/ +# https://market.ft.tech/gateway/ ``` 全局修改，影响之后创建的新客户端： ```python -ft.set_base_url("https://market.ft.tech/data/") +ft.set_base_url("https://market.ft.tech/gateway/") market = ft.market_api() ``` 只修改某个客户端： ```python -market = ft.market_api(base_url="https://market.ft.tech/data/") +market = ft.market_api(base_url="https://market.ft.tech/gateway/") ``` -SDK 会规范化 URL，`https://host/data` 和 `https://host/data/` 都可以。 +SDK 会规范化 URL，`https://host/gateway` 和 `https://host/gateway/` 都可以。 ## 返回类型 @@ -367,10 +373,10 @@ src/ftshare/ client.py # FtshareClient 组合类和 market_api 工厂 config.py # BASE_URL、默认分页大小和全局配置 dataframe.py # pandas DataFrame 转换 - endpoints.py # 接口 path 注册表 + endpoints/ # 按 ftshare-doc 专题拆分的接口注册表 exceptions.py # SDK 异常类型 fields.py # fields 参数解析和列筛选 pagination.py # page/page_size/limit/max_pages 校验 response.py # API 业务错误、records/items 提取、总页数解析 - apis/ # 按业务域组织的接口 mixin + apis/ # 按 ftshare-doc 专题拆分的接口 mixin ``` diff --git a/docs/API_REFERENCE.md b/docs/API_REFERENCE.md index 8f1c724..88c38e0 100644 --- a/docs/API_REFERENCE.md +++ b/docs/API_REFERENCE.md @@ -1,12 +1,32 @@ # FTShare Python SDK API Reference -本文档由 SDK 方法 docstring 和 `ftshare.endpoints.ENDPOINTS` 生成，用于查看 Python SDK 当前暴露的接口方法。 +本文档由 SDK 方法 docstring 和 `ftshare.endpoints.ENDPOINTS` 生成。接口分组与 `ftshare-doc/api-doc` 顶层专题保持一致。 ## 汇总 | 指标 | 数量 | |---|---:| -| SDK 方法总数 | 176 | +| SDK 方法总数 | 179 | + +## 专题分布 + +接口分组、`src/ftshare/apis/` 方法模块和 `src/ftshare/endpoints/` 注册表模块均按 `ftshare-doc/api-doc` 顶层专题对齐。 + +| ftshare-doc 专题 | SDK 方法数 | API mixin 模块 | Endpoint 模块 | +|---|---:|---|---| +| 股票数据 | 95 | `ftshare.apis.stock` | `ftshare.endpoints.stock` | +| 港股数据 | 14 | `ftshare.apis.hk` | `ftshare.endpoints.hk` | +| 美股数据 | 9 | `ftshare.apis.us` | `ftshare.endpoints.us` | +| 指数专题 | 8 | `ftshare.apis.index` | `ftshare.endpoints.index` | +| ETF专题 | 8 | `ftshare.apis.etf` | `ftshare.endpoints.etf` | +| 公募基金 | 5 | `ftshare.apis.fund` | `ftshare.endpoints.fund` | +| 期货数据 | 9 | `ftshare.apis.futures` | `ftshare.endpoints.futures` | +| 债券专题 | 2 | `ftshare.apis.bond` | `ftshare.endpoints.bond` | +| 宏观经济 | 17 | `ftshare.apis.economic` | `ftshare.endpoints.economic` | +| 大模型语料 | 5 | `ftshare.apis.llm_corpus` | `ftshare.endpoints.llm_corpus` | +| 现货数据 | 2 | `ftshare.apis.spot` | `ftshare.endpoints.spot` | +| 外汇数据 | 1 | `ftshare.apis.forex` | `ftshare.endpoints.forex` | +| 未发布 | 4 | `ftshare.apis.unpublished` | `ftshare.endpoints.unpublished` | ## 使用方式 @@ -24,280 +44,333 @@ df = market.baidu_financial_calendar( ## 接口索引 -### 财务数据 - -| SDK 方法 | 接口名称 | HTTP | Path | 参数 | 状态 | 来源文档 | -|---|---|---|---|---|---|---| -| [`baidu_financial_calendar`](#api-baidu-financial-calendar) | 百度财经日历 | `GET` | `api/v1/market/data/finance/financial-calendar/baidu` | `start_date`, `end_date`, `category`, `page`, `page_size` | 可调用 | `百度财经日历.md` | -| [`balance`](#api-balance) | A股资产负债表 | `GET` | `api/v1/market/data/finance/balance` | `stock_code`, `year`, `report_type`, `page`, `page_size` | 可调用 | `A股资产负债表.md` | -| [`cashflow`](#api-cashflow) | A股现金流量表 | `GET` | `api/v1/market/data/finance/cashflow` | `stock_code`, `year`, `report_type`, `page`, `page_size` | 可调用 | `A股现金流量表.md` | -| [`cashflow_stock_code`](#api-cashflow-stock-code) | 现金流支持股票代码 | `GET` | `api/v1/market/data/finance/cashflow-stock-code` | - | 可调用 | `现金流支持股票代码.md` | -| [`earnings_reports_paginated`](#api-earnings-reports-paginated) | 业绩快报 | `GET` | `api/v1/market/data/finance/stock-performance-express` | `stock_code`, `year`, `report_type`, `page`, `page_size` | 可调用 | `业绩快报.md` | -| [`income`](#api-income) | A股利润表 | `GET` | `api/v1/market/data/finance/income` | `stock_code`, `year`, `report_type`, `page`, `page_size` | 可调用 | `A股利润表.md` | -| [`performance_forecasts_paginated`](#api-performance-forecasts-paginated) | 业绩预告 | `GET` | `api/v1/market/data/finance/stock-performance-forecast` | `stock_code`, `year`, `report_type`, `page`, `page_size` | 可调用 | `业绩预告.md` | -| [`wallstreetcn_financial_calendar`](#api-wallstreetcn-financial-calendar) | 华尔街见闻财经日历 | `GET` | `api/v1/market/data/finance/financial-calendar/wallstreetcn` | `start_date`, `end_date`, `page`, `page_size` | 可调用 | `华尔街见闻财经日历.md` | +### 股票数据 + +| SDK 方法 | 接口名称 | HTTP | Path | 参数 | 来源文档 | +|---|---|---|---|---|---| +| [`abnormal_trading_details`](#api-abnormal-trading-details) | 龙虎榜明细 | `GET` | `api/v1/market/data/abnormal-trading-details` | `date` | `龙虎榜明细.md` | +| [`abnormal_trading_overview`](#api-abnormal-trading-overview) | 龙虎榜总览 | `GET` | `api/v1/market/data/abnormal-trading-overview` | `date` | `龙虎榜总览.md` | +| [`auction_results`](#api-auction-results) | 集合竞价结果 | `GET` | `api/v1/market/data/auction-results` | `ts_code`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` | `集合竞价结果.md` | +| [`balance`](#api-balance) | A股资产负债表 | `GET` | `api/v1/market/data/finance/balance` | `stock_code`, `year`, `report_type`, `page`, `page_size` | `A股资产负债表.md` | +| [`block_trades`](#api-block-trades) | 大宗交易 | `GET` | `api/v1/market/data/block-trades` | `date` | `大宗交易.md` | +| [`bse_mapping`](#api-bse-mapping) | 北交所映射 | `GET` | `api/v1/market/data/bse-mapping` | `o_code`, `n_code` | `北交所映射.md` | +| [`cashflow`](#api-cashflow) | A股现金流量表 | `GET` | `api/v1/market/data/finance/cashflow` | `stock_code`, `year`, `report_type`, `page`, `page_size` | `A股现金流量表.md` | +| [`cashflow_stock_code`](#api-cashflow-stock-code) | 现金流支持股票代码 | `GET` | `api/v1/market/data/finance/cashflow-stock-code` | - | `现金流支持股票代码.md` | +| [`company_list`](#api-company-list) | 公司列表 | `GET` | `api/v1/market/data/company-list` | `stock_name`, `stock_code`, `page`, `page_size` | `公司列表.md` | +| [`earnings_reports_paginated`](#api-earnings-reports-paginated) | 业绩快报 | `GET` | `api/v1/market/data/finance/stock-performance-express` | `stock_code`, `year`, `report_type`, `page`, `page_size` | `业绩快报.md` | +| [`eastmoney_board_constituents`](#api-eastmoney-board-constituents) | 东方财富板块成份股 | `GET` | `api/v1/market/data/eastmoney-board-constituents` | `board_code` | `东方财富板块成份股.md` | +| [`eastmoney_board_daily_kline`](#api-eastmoney-board-daily-kline) | 东方财富板块日线OHLC | `GET` | `api/v1/market/data/eastmoney-board-daily-ohlc` | `board_code`, `start_date`, `end_date`, `page`, `page_size` | `东方财富板块日线OHLC.md` | +| [`eastmoney_board_latest_kline`](#api-eastmoney-board-latest-kline) | 东方财富板块最新OHLC | `GET` | `api/v1/market/data/eastmoney-board-latest-ohlc` | `board_code`, `page`, `page_size` | `东方财富板块最新OHLC.md` | +| [`eastmoney_concept_boards`](#api-eastmoney-concept-boards) | 东方财富概念板块 | `GET` | `api/v1/market/data/eastmoney-concept-boards` | - | `东方财富概念板块.md` | +| [`eastmoney_dapan_flow`](#api-eastmoney-dapan-flow) | 东方财富大盘资金流 | `GET` | `api/v1/market/data/eastmoney-dapan-flow` | `trade_date`, `start_date`, `end_date`, `page`, `page_size` | `东方财富大盘资金流.md` | +| [`eastmoney_market_valuation`](#api-eastmoney-market-valuation) | 东方财富市场估值 | `GET` | `api/v1/market/data/eastmoney-market-valuation` | `market_code`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` | `东方财富市场估值.md` | +| [`eastmoney_rank`](#api-eastmoney-rank) | 东方财富股票排名 | `GET` | `api/v1/market/data/eastmoney-rank` | `rank_group`, `market`, `trade_date` | `东方财富股票排名.md` | +| [`eastmoney_sector_flow`](#api-eastmoney-sector-flow) | 东方财富板块资金流 | `GET` | `api/v1/market/data/eastmoney-sector-flow` | `sector_code`, `sector_type`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` | `东方财富板块资金流.md` | +| [`eastmoney_stock_flow`](#api-eastmoney-stock-flow) | 东方财富个股资金流 | `GET` | `api/v1/market/data/eastmoney-stock-flow` | `symbol`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` | `东方财富个股资金流.md` | +| [`eastmoney_stock_valuation`](#api-eastmoney-stock-valuation) | 东方财富个股估值 | `GET` | `api/v1/market/data/eastmoney-stock-valuation` | `symbol`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` | `东方财富个股估值.md` | +| [`goodwill_industry`](#api-goodwill-industry) | 商誉行业 | `GET` | `api/v1/market/data/goodwill/industry` | `date`, `page`, `page_size` | `商誉行业.md` | +| [`goodwill_market_overview`](#api-goodwill-market-overview) | 商誉市场总览 | `GET` | `api/v1/market/data/goodwill/market-overview` | - | `商誉市场总览.md` | +| [`goodwill_predict`](#api-goodwill-predict) | 商誉预测 | `GET` | `api/v1/market/data/goodwill/predict` | `date`, `page`, `page_size` | `商誉预测.md` | +| [`goodwill_stock_detail`](#api-goodwill-stock-detail) | 商誉个股明细 | `GET` | `api/v1/market/data/goodwill/stock-detail` | `date`, `page`, `page_size` | `商誉个股明细.md` | +| [`goodwill_stock_impairment`](#api-goodwill-stock-impairment) | 商誉减值 | `GET` | `api/v1/market/data/goodwill/stock-impairment` | `date`, `page`, `page_size` | `商誉减值.md` | +| [`hk_sh_stock_connect_members`](#api-hk-sh-stock-connect-members) | 沪港通成份 | `GET` | `api/v1/market/data/hk-sh-stock-connect-members` | - | `沪港通成份.md` | +| [`hk_sz_stock_connect_members`](#api-hk-sz-stock-connect-members) | 深港通成份 | `GET` | `api/v1/market/data/hk-sz-stock-connect-members` | - | `深港通成份.md` | +| [`income`](#api-income) | A股利润表 | `GET` | `api/v1/market/data/finance/income` | `stock_code`, `year`, `report_type`, `page`, `page_size` | `A股利润表.md` | +| [`limit_down_pool`](#api-limit-down-pool) | 跌停池 | `GET` | `api/v1/market/data/limit-down-pool` | - | `跌停池.md` | +| [`limit_event_timeline_3s`](#api-limit-event-timeline-3s) | 涨跌停事件时间线 | `GET` | `api/v1/market/data/limit-event-timeline-3s` | `symbol` | `涨跌停事件时间线.md` | +| [`limit_up_break_pool`](#api-limit-up-break-pool) | 炸板池 | `GET` | `api/v1/market/data/limit-up-break-pool` | - | `炸板池.md` | +| [`limit_up_pool`](#api-limit-up-pool) | 涨停池 | `GET` | `api/v1/market/data/limit-up-pool` | - | `涨停池.md` | +| [`limit_up_pool_yesterday`](#api-limit-up-pool-yesterday) | 昨日涨停池 | `GET` | `api/v1/market/data/limit-up-pool-yesterday` | - | `昨日涨停池.md` | +| [`margin_trading_details`](#api-margin-trading-details) | 融资融券明细 | `GET` | `api/v1/market/data/margin-trading-details` | `date`, `page`, `page_size` | `融资融券明细.md` | +| [`margin_trading_details_paginated`](#api-margin-trading-details-paginated) | 融资融券明细分页 | `GET` | `api/v1/market/data/margin-trading-details` | `date`, `page`, `page_size` | `融资融券明细分页.md` | +| [`northbound`](#api-northbound) | 北向资金交易 | `GET` | `api/v1/market/data/northbound` | `date` | `北向资金交易.md` | +| [`nth_trade_date`](#api-nth-trade-date) | 第N个交易日 | `GET` | `api/v1/market/data/time/get-nth-trade-date` | `n` | `第N个交易日.md` | +| [`performance_forecasts_paginated`](#api-performance-forecasts-paginated) | 业绩预告 | `GET` | `api/v1/market/data/finance/stock-performance-forecast` | `stock_code`, `year`, `report_type`, `page`, `page_size` | `业绩预告.md` | +| [`price_change`](#api-price-change) | 价格变动 | `GET` | `api/v1/market/data/price/get-price-change` | `stock_code`, `base_date`, `n`, `direction` | `价格变动.md` | +| [`risk_warning_stock_quotes`](#api-risk-warning-stock-quotes) | 风险警示股行情 | `GET` | `api/v1/market/data/risk-warning-stocks/quotes` | `date` | `风险警示股行情.md` | +| [`risk_warning_stocks`](#api-risk-warning-stocks) | 风险警示股 | `GET` | `api/v1/market/data/risk-warning-stocks` | `date` | `风险警示股.md` | +| [`search`](#api-search) | 标的搜索 | `GET` | `api/v1/market/security/search` | `query`, `limit` | `标的搜索.md` | +| [`sh_hk_stock_connect_members`](#api-sh-hk-stock-connect-members) | 沪股通成份 | `GET` | `api/v1/market/data/sh-hk-stock-connect-members` | - | `沪股通成份.md` | +| [`southbound`](#api-southbound) | 南向资金交易 | `GET` | `api/v1/market/data/southbound` | `date` | `南向资金交易.md` | +| [`stk_ah_comparison`](#api-stk-ah-comparison) | AH股对比 | `GET` | `api/v1/market/data/hk/stk-ah-comparison` | `hk_code`, `ts_code`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` | `AH股对比.md` | +| [`stk_limit`](#api-stk-limit) | 涨跌停价 | `GET` | `api/v1/market/data/stk-limit` | `instrument_type`, `symbol`, `symbol_id`, `market_id`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` | `涨跌停价.md` | +| [`stk_premarket`](#api-stk-premarket) | 盘前数据 | `GET` | `api/v1/market/data/stk-premarket` | `ts_code`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` | `盘前数据.md` | +| [`stock_adjust_factor`](#api-stock-adjust-factor) | 股票复权因子 | `GET` | `api/v1/market/data/stock-adjust-factor` | `symbol`, `trade_date`, `start_date`, `end_date`, `offset`, `limit` | `股票复权因子.md` | +| [`stock_candlesticks`](#api-stock-candlesticks) | 股票K线 | `POST` | `api/v1/market/data/stock-candlesticks` | `symbol`, `interval_unit`, `interval_value`, `adjust_kind`, `since_ts_millis`, `until_ts_millis`, `limit` | `股票K线.md` | +| [`stock_candlesticks_batch`](#api-stock-candlesticks-batch) | 批量股票K线 | `POST` | `api/v1/market/data/stock-candlesticks/batch` | `symbols`, `interval_unit`, `interval_value`, `adjust_kind`, `since_ts_millis`, `until_ts_millis`, `limit` | `批量股票K线.md` | +| [`stock_capital_flows_paginated`](#api-stock-capital-flows-paginated) | 股票资金流向 | `GET` | `api/v1/market/data/stock-capital-flows` | `date`, `page`, `page_size` | `股票资金流向.md` | +| [`stock_comment_desire_em`](#api-stock-comment-desire-em) | 千股千评意愿度 | `GET` | `api/v1/market/data/stock-comment/desire` | `symbol` | `千股千评意愿度.md` | +| [`stock_comment_em`](#api-stock-comment-em) | 千股千评 | `GET` | `api/v1/market/data/stock-comment/index` | `page`, `page_size` | `千股千评.md` | +| [`stock_comment_focus_em`](#api-stock-comment-focus-em) | 千股千评关注度 | `GET` | `api/v1/market/data/stock-comment/focus` | `symbol` | `千股千评关注度.md` | +| [`stock_comment_org_participate_em`](#api-stock-comment-org-participate-em) | 机构参与度 | `GET` | `api/v1/market/data/stock-comment/org-participate` | `symbol` | `机构参与度.md` | +| [`stock_comment_score_em`](#api-stock-comment-score-em) | 千股千评评分 | `GET` | `api/v1/market/data/stock-comment/score` | `symbol` | `千股千评评分.md` | +| [`stock_filter`](#api-stock-filter) | 股票筛选 | `GET` | `api/v1/market/data/stock-list/filter` | `board`, `listing_date_since`, `page`, `page_size` | `股票筛选.md` | +| [`stock_float_holders`](#api-stock-float-holders) | 十大流通股东 | `GET` | `api/v1/market/data/holder/stock-holder-ften` | `stock_code`, `is_last`, `page`, `page_size` | `十大流通股东.md` | +| [`stock_ggcg_em`](#api-stock-ggcg-em) | 东方财富股东增减持 | `GET` | `api/v1/market/data/holder/stock-ggcg-em` | `symbol`, `page`, `page_size` | `东方财富股东增减持.md` | +| [`stock_ggmx`](#api-stock-ggmx) | 董监高持股变动 | `GET` | `api/v1/market/data/holder/stock-ggmx` | `stock_code`, `change_direction`, `start_date`, `end_date`, `page`, `page_size` | `董监高持股变动.md` | +| [`stock_ggmx_buy_ranking`](#api-stock-ggmx-buy-ranking) | 董监高增持排名 | `GET` | `api/v1/market/data/holder/stock-ggmx-buy-ranking` | `time_range`, `page`, `page_size` | `董监高增持排名.md` | +| [`stock_ggmx_sell_ranking`](#api-stock-ggmx-sell-ranking) | 董监高减持排名 | `GET` | `api/v1/market/data/holder/stock-ggmx-sell-ranking` | `time_range`, `page`, `page_size` | `董监高减持排名.md` | +| [`stock_holders`](#api-stock-holders) | 十大股东 | `GET` | `api/v1/market/data/holder/stock-holder-ten` | `stock_code`, `is_last`, `page`, `page_size` | `十大股东.md` | +| [`stock_holders_number`](#api-stock-holders-number) | 股东人数 | `GET` | `api/v1/market/data/holder/stock-holder-nums` | `stock_code`, `is_last`, `page`, `page_size` | `股东人数.md` | +| [`stock_institution_holdings`](#api-stock-institution-holdings) | 机构持股 | `GET` | `api/v1/market/data/share/stock-institution-holdings` | `year`, `report_type`, `inst_type`, `page`, `page_size` | `机构持股.md` | +| [`stock_institution_holdings_detail`](#api-stock-institution-holdings-detail) | 机构持股明细 | `GET` | `api/v1/market/data/share/stock-institution-holdings-detail` | `stock_code`, `year`, `report_type`, `inst_type`, `page`, `page_size` | `机构持股明细.md` | +| [`stock_institution_share_holdings`](#api-stock-institution-share-holdings) | 机构股本持股 | `GET` | `api/v1/market/data/institution/institution-share-holdings` | `institution_id`, `year`, `report_type`, `invest_type` | `机构股本持股.md` | +| [`stock_intraday_auction_volume`](#api-stock-intraday-auction-volume) | 集合竞价成交量 | `GET` | `api/v1/market/data/intraday-auction-volume` | `trade_date`, `page`, `page_size` | `集合竞价成交量.md` | +| [`stock_intraday_auction_volume_symbol`](#api-stock-intraday-auction-volume-symbol) | 单标的集合竞价成交量 | `GET` | `api/v1/market/data/intraday-auction-volume/symbol` | `symbol`, `trade_date`, `page`, `page_size` | `单标的集合竞价成交量.md` | +| [`stock_ipos`](#api-stock-ipos) | 股票IPO | `GET` | `api/v1/market/data/stock-ipos` | `page`, `page_size` | `股票IPO.md` | +| [`stock_list`](#api-stock-list) | 股票列表 | `GET` | `api/v1/market/data/stock-list` | - | `股票列表.md` | +| [`stock_market`](#api-stock-market) | 市场行情快照 | `GET` | `api/v1/market/data/daec/market/snapshot` | `scope` | `市场行情快照.md` | +| [`stock_market_distribution_intraday`](#api-stock-market-distribution-intraday) | 日内涨跌停分布历史 | `GET` | `api/v1/market/data/daec/market/distribution-history` | `scope` | `日内涨跌停分布历史.md` | +| [`stock_daec_stocks`](#api-stock-daec-stocks) | A股行情列表 | `GET` | `api/v1/market/data/daec/stocks/{board}` | `board`, `page`, `page_size`, `filter`, `order_by` | `A股行情列表.md` | +| [`stock_realtime_list`](#api-stock-realtime-list) | A股行情列表 | `GET` | `api/v1/market/data/stock-list/{board}` | `board`, `page`, `page_size` | `A股行情列表.md` | +| [`stock_pledge_detail`](#api-stock-pledge-detail) | 股权质押明细 | `GET` | `api/v1/market/data/pledge/pledge-detail` | `stock_code`, `is_last`, `page`, `page_size` | `股权质押明细.md` | +| [`stock_pledge_summary`](#api-stock-pledge-summary) | 股权质押汇总 | `GET` | `api/v1/market/data/pledge/pledge-summary` | `page`, `page_size` | `股权质押汇总.md` | +| [`stock_prev_close`](#api-stock-prev-close) | 标的昨收价 | `GET` | `api/v1/market/data/daec/history/prev-closes` | `symbol`, `since`, `until` | `标的昨收价.md` | +| [`stock_intraday_prices`](#api-stock-intraday-prices) | 标的分时数据 | `GET` | `api/v1/market/data/daec/history/prices` | `symbol`, `range`, `days`, `ts_ms` | `标得分时数据.md` | +| [`stock_rating_top5`](#api-stock-rating-top5) | 飞兔股票评级Top5 | `GET` | `api/v1/market/data/feitu/stock-rating-top5` | `date`, `variant`, `type` | `飞兔股票评级Top5.md` | +| [`stock_share`](#api-stock-share) | 股本 | `GET` | `api/v1/market/data/share/get-stock-share` | `stock_code`, `date` | `股本.md` | +| [`stock_share_chg`](#api-stock-share-chg) | 股东增减持 | `GET` | `api/v1/market/data/holder/stock-share-chg` | `stock_code`, `is_last`, `page`, `page_size` | `股东增减持.md` | +| [`stock_signal_latest_snapshot`](#api-stock-signal-latest-snapshot) | 信号最新快照 | `GET` | `api/v1/market/data/stock-signal-latest-snapshot` | `signal_type`, `page`, `page_size` | `信号最新快照.md` | +| [`stock_trade`](#api-stock-trade) | 标的逐笔成交 | `GET` | `api/v1/market/data/daec/history/trades` | `symbol` | `标的逐笔成交.md` | +| [`stock_unlock`](#api-stock-unlock) | 限售解禁 | `GET` | `api/v1/market/data/unlock/stock-unlock` | `stock_code`, `page`, `page_size` | `限售解禁.md` | +| [`stock_unlock_by_date`](#api-stock-unlock-by-date) | 限售解禁按日期 | `GET` | `api/v1/market/data/unlock/stock-unlock-by-date` | `start_date`, `end_date`, `page`, `page_size` | `限售解禁按日期.md` | +| [`suspension_list`](#api-suspension-list) | 停牌列表 | `GET` | `api/v1/market/data/suspension-list` | `trade_date`, `page`, `page_size` | `停牌列表.md` | +| [`sz_hk_stock_connect_members`](#api-sz-hk-stock-connect-members) | 深股通成份 | `GET` | `api/v1/market/data/sz-hk-stock-connect-members` | - | `深股通成份.md` | +| [`ths_all_board_kline`](#api-ths-all-board-kline) | 同花顺全板块K线 | `GET` | `api/v1/market/data/ths-all-board-kline` | `start_date`, `end_date`, `page`, `page_size` | `同花顺全板块K线.md` | +| [`ths_board_kline`](#api-ths-board-kline) | 同花顺板块K线 | `GET` | `api/v1/market/data/ths-board-kline` | `board_code`, `page`, `page_size` | `同花顺板块K线.md` | +| [`ths_board_list`](#api-ths-board-list) | 同花顺板块列表 | `GET` | `api/v1/market/data/ths-board-list` | - | `同花顺板块列表.md` | +| [`xueqiu_rank`](#api-xueqiu-rank) | 雪球股票排名 | `GET` | `api/v1/market/data/xueqiu-rank` | `rank_group`, `period`, `trade_date`, `page`, `page_size` | `雪球股票排名.md` | +| [`yzxdr_detail`](#api-yzxdr-detail) | 除权除息明细 | `GET` | `api/v1/market/data/yzxdr-detail` | `year`, `quarter`, `stock_code`, `page`, `page_size` | `除权除息明细.md` | +| [`pledge_summary`](#api-pledge-summary) | 股权质押汇总 | `GET` | `api/v1/market/data/pledge/pledge-summary` | `page`, `page_size` | `股权质押汇总.md` | +| [`stock_capital_flows`](#api-stock-capital-flows) | 股票资金流向 | `GET` | `api/v1/market/data/stock-capital-flows` | `date`, `page`, `page_size` | `股票资金流向.md` | + +### 港股数据 + +| SDK 方法 | 接口名称 | HTTP | Path | 参数 | 来源文档 | +|---|---|---|---|---|---| +| [`company_hk`](#api-company-hk) | 港股公司信息 | `GET` | `api/v1/market/data/hk/company-hk` | `trade_code` | `港股公司信息.md` | +| [`eastmoney_hk_index_daily_kline`](#api-eastmoney-hk-index-daily-kline) | 东方财富港股指数日K | `GET` | `api/v1/market/data/eastmoney-hk-index-daily-kline` | `index_code`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` | `东方财富港股指数日K.md` | +| [`hk_balance_bank`](#api-hk-balance-bank) | 港股资产负债表 | `GET` | `api/v1/market/data/hk/hk-balance-bank` | `trade_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` | `港股资产负债表.md` | +| [`hk_balance_gene`](#api-hk-balance-gene) | 港股资产负债表 | `GET` | `api/v1/market/data/hk/hk-balance-gene` | `trade_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` | `港股资产负债表.md` | +| [`hk_balance_insur`](#api-hk-balance-insur) | 港股资产负债表 | `GET` | `api/v1/market/data/hk/hk-balance-insur` | `trade_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` | `港股资产负债表.md` | +| [`hk_basinfo_get`](#api-hk-basinfo-get) | 港股个股信息 | `GET` | `api/v1/market/data/hk/hk-view` | `hk_code` | `港股个股信息.md` | +| [`hk_basinfo_post`](#api-hk-basinfo-post) | 港股个股信息 | `GET` | `api/v1/market/data/hk/hk-view` | `hk_code` | `港股个股信息.md` | +| [`hk_candlesticks`](#api-hk-candlesticks) | 港股K线 | `GET` | `api/v1/market/data/hk/hk-candlesticks` | `trade_code`, `interval_unit`, `until_date`, `since_date`, `interval_value`, `limit`, `adjust_kind` | `港股K线.md` | +| [`hk_cashflow`](#api-hk-cashflow) | 港股现金流量表 | `GET` | `api/v1/market/data/hk/hk-cashflow` | `stock_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` | `港股现金流量表.md` | +| [`hk_income_bank`](#api-hk-income-bank) | 港股利润表 | `GET` | `api/v1/market/data/hk/hk-income-bank` | `trade_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` | `港股利润表.md` | +| [`hk_income_gene`](#api-hk-income-gene) | 港股利润表 | `GET` | `api/v1/market/data/hk/hk-income-gene` | `trade_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` | `港股利润表.md` | +| [`hk_income_insur`](#api-hk-income-insur) | 港股利润表 | `GET` | `api/v1/market/data/hk/hk-income-insur` | `trade_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` | `港股利润表.md` | +| [`hk_valuatnanalyd`](#api-hk-valuatnanalyd) | 港股估值分析 | `GET` | `api/v1/market/data/hk/hk-valuatnanalyd` | `trade_code`, `page`, `page_size` | `港股估值分析.md` | +| [`market_cap_hk`](#api-market-cap-hk) | 港股市值 | `GET` | `api/v1/market/data/hk/market-cap-hk` | `trade_code` | `港股市值.md` | + +### 美股数据 + +| SDK 方法 | 接口名称 | HTTP | Path | 参数 | 来源文档 | +|---|---|---|---|---|---| +| [`eastmoney_us_stock_daily_kline`](#api-eastmoney-us-stock-daily-kline) | 东方财富美股日OHLC | `GET` | `api/v1/market/data/eastmoney-us-stock-daily-ohlc` | `stock_code`, `start_date`, `end_date`, `page`, `page_size` | `东方财富美股日OHLC.md` | +| [`eastmoney_us_stock_latest_kline`](#api-eastmoney-us-stock-latest-kline) | 东方财富美股最新OHLC | `GET` | `api/v1/market/data/eastmoney-us-stock-latest-ohlc` | `stock_code`, `page`, `page_size` | `东方财富美股最新OHLC.md` | +| [`eastmoney_us_stock_list`](#api-eastmoney-us-stock-list) | 东方财富美股列表 | `GET` | `api/v1/market/data/eastmoney-us-stock-list` | `refresh`, `page`, `page_size` | `东方财富美股列表.md` | +| [`us_balance`](#api-us-balance) | 美股资产负债表 | `GET` | `api/v1/market/data/us/us-balance` | `stock_code`, `period`, `report_type`, `start_date`, `end_date`, `page`, `page_size` | `美股资产负债表.md` | +| [`us_basic`](#api-us-basic) | 美股基础信息 | `GET` | `api/v1/market/data/us/us-basic` | `stock_code`, `page`, `page_size` | `美股基础信息.md` | +| [`us_cashflow`](#api-us-cashflow) | 美股现金流 | `GET` | `api/v1/market/data/us/us-cashflow` | `stock_code`, `period`, `report_type`, `start_date`, `end_date`, `page`, `page_size` | `美股现金流.md` | +| [`us_income`](#api-us-income) | 美股利润表 | `GET` | `api/v1/market/data/us/us-income` | `stock_code`, `period`, `report_type`, `start_date`, `end_date`, `page`, `page_size` | `美股利润表.md` | +| [`eastmoney_us_stock_daily_ohlc`](#api-eastmoney-us-stock-daily-ohlc) | 东方财富美股日OHLC | `GET` | `api/v1/market/data/eastmoney-us-stock-daily-ohlc` | `stock_code`, `start_date`, `end_date`, `page`, `page_size` | `东方财富美股日OHLC.md` | +| [`eastmoney_us_stock_latest_ohlc`](#api-eastmoney-us-stock-latest-ohlc) | 东方财富美股最新OHLC | `GET` | `api/v1/market/data/eastmoney-us-stock-latest-ohlc` | `stock_code`, `page`, `page_size` | `东方财富美股最新OHLC.md` | + +### 指数专题 + +| SDK 方法 | 接口名称 | HTTP | Path | 参数 | 来源文档 | +|---|---|---|---|---|---| +| [`global_index_daily_kline`](#api-global-index-daily-kline) | 全球指数日K线 | `GET` | `api/v1/market/data/global-index/daily-kline` | `secid`, `start_date`, `end_date` | `全球指数日K线.md` | +| [`index_description_all`](#api-index-description-all) | 指数基础信息 | `GET` | `api/v1/market/data/index-description-all` | - | `指数基础信息.md` | +| [`index_description_list`](#api-index-description-list) | 中证指数描述列表 | `GET` | `api/v1/market/data/index/index_description` | `page`, `page_size` | `中证指数描述列表.md` | +| [`index_weight_list`](#api-index-weight-list) | 指数权重列表 | `GET` | `api/v1/market/data/index/index_weight` | `index_code`, `date`, `page`, `page_size` | `指数权重列表.md` | +| [`index_weight_summary`](#api-index-weight-summary) | 指数权重汇总 | `GET` | `api/v1/market/data/index/index_weight_summary` | `page`, `page_size` | `指数权重汇总.md` | +| [`sw_industry_constituent_history`](#api-sw-industry-constituent-history) | 申万行业成份股历史 | `GET` | `api/v1/market/data/sw-industry/constituent-history` | `industry_code` | `申万行业成份股历史.md` | +| [`sw_industry_daily_metrics`](#api-sw-industry-daily-metrics) | 申万行业日度指标 | `GET` | `api/v1/market/data/sw-industry/daily-metrics` | `level`, `start_date`, `end_date`, `industry_code`, `page`, `page_size` | `申万行业日度指标.md` | +| [`sw_industry_overview`](#api-sw-industry-overview) | 申万行业总览 | `GET` | `api/v1/market/data/sw-industry/overview` | `date`, `level`, `page`, `page_size` | `申万行业总览.md` | + +### ETF专题 + +| SDK 方法 | 接口名称 | HTTP | Path | 参数 | 来源文档 | +|---|---|---|---|---|---| +| [`etf_adjust_factor`](#api-etf-adjust-factor) | ETF复权因子 | `GET` | `api/v1/market/data/etf-adjust-factor` | `symbol`, `trade_date`, `start_date`, `end_date`, `offset`, `limit` | `ETF复权因子.md` | +| [`etf_components`](#api-etf-components) | ETF成份股 | `GET` | `api/v1/market/data/etf-component` | `symbol` | `ETF成份股.md` | +| [`etf_components_all`](#api-etf-components-all) | ETF成份列表 | `GET` | `api/v1/market/data/etf-components-all` | - | `ETF成份列表.md` | +| [`etf_description_all`](#api-etf-description-all) | ETF基础信息 | `GET` | `api/v1/market/data/etf-description-all` | - | `ETF基础信息.md` | +| [`etf_fund_export`](#api-etf-fund-export) | 指数ETF基金导出 | `GET` | `api/v1/market/data/etf/zhitou-etf` | `request_id`, `page`, `page_size` | `指数ETF基金导出.md` | +| [`etf_pcf_list`](#api-etf-pcf-list) | ETF-PCF清单列表 | `GET` | `api/v1/market/data/etf-pcf/etf-pcfs` | `date`, `page`, `page_size` | `ETF-PCF清单列表.md` | +| [`etf_pre`](#api-etf-pre) | ETF盘前数据 | `GET` | `api/v1/market/data/etf-pre-data` | `date` | `ETF盘前数据.md` | +| [`etf_pre_single`](#api-etf-pre-single) | 单只ETF盘前数据 | `GET` | `api/v1/market/data/etf-pre-single` | `symbol`, `date` | `单只ETF盘前数据.md` | + +### 公募基金 + +| SDK 方法 | 接口名称 | HTTP | Path | 参数 | 来源文档 | +|---|---|---|---|---|---| +| [`fund_basicinfo`](#api-fund-basicinfo) | 基金基础信息 | `GET` | `api/v1/market/data/fund/fund-basicinfo` | `institution_code`, `page`, `page_size` | `基金基础信息.md` | +| [`fund_cal_return`](#api-fund-cal-return) | 基金收益 | `GET` | `api/v1/market/data/fund/fund-cal-return` | `institution_code`, `cal-type` | `基金收益.md` | +| [`fund_nav`](#api-fund-nav) | 基金净值 | `GET` | `api/v1/market/data/fund/fund-nav` | `institution_code`, `page`, `page_size` | `基金净值.md` | +| [`fund_overview`](#api-fund-overview) | 基金总览 | `GET` | `api/v1/market/data/fund/fund-overview` | `page`, `page_size` | `基金总览.md` | +| [`fund_support_symbols`](#api-fund-support-symbols) | 基金支持标的 | `GET` | `api/v1/market/data/fund/fund-support-symbols` | `page`, `page_size` | `基金支持标的.md` | + +### 期货数据 + +| SDK 方法 | 接口名称 | HTTP | Path | 参数 | 来源文档 | +|---|---|---|---|---|---| +| [`china_futures_base_data`](#api-china-futures-base-data) | 中国期货基础数据 | `GET` | `api/v1/market/data/futures/futures-base-data` | `trade_date`, `symbol` | `中国期货基础数据.md` | +| [`china_futures_lists`](#api-china-futures-lists) | 中国期货列表 | `GET` | `api/v1/market/data/futures/futures-lists` | `trade_date` | `中国期货列表.md` | +| [`eastmoney_futures_position`](#api-eastmoney-futures-position) | 东方财富期货持仓 | `GET` | `api/v1/market/data/eastmoney-futures-position` | `exchange`, `variety_code`, `contract_code`, `trade_date`, `start_date`, `end_date`, `member_name_abbr`, `page`, `page_size` | `东方财富期货持仓.md` | +| [`futures_contract_kline`](#api-futures-contract-kline) | 期货合约K线 | `GET` | `api/v1/market/data/futures/kline` | `symbol`, `interval`, `start`, `end`, `limit` | `期货合约K线.md` | +| [`major_contract`](#api-major-contract) | 重大合同 | `GET` | `api/v1/market/data/corporate/contract` | `start_date`, `end_date` | `重大合同.md` | +| [`major_contract_by_symbol`](#api-major-contract-by-symbol) | 重大合同按标的 | `GET` | `api/v1/market/data/corporate/contract/by-symbol` | `symbol`, `page`, `page_size` | `重大合同按标的.md` | +| [`major_contract_summary`](#api-major-contract-summary) | 重大合同汇总 | `GET` | `api/v1/market/data/corporate/contract/summary` | `page`, `page_size` | `重大合同汇总.md` | +| [`eastmoney_futures_strange`](#api-eastmoney-futures-strange) | 东方财富期货持仓 | `GET` | `api/v1/market/data/eastmoney-futures-position` | `exchange`, `variety_code`, `contract_code`, `trade_date`, `start_date`, `end_date`, `member_name_abbr`, `page`, `page_size` | `东方财富期货持仓.md` | +| [`futures_kline`](#api-futures-kline) | 期货合约K线 | `GET` | `api/v1/market/data/futures/kline` | `symbol`, `interval`, `start`, `end`, `limit` | `期货合约K线.md` | + +### 债券专题 + +| SDK 方法 | 接口名称 | HTTP | Path | 参数 | 来源文档 | +|---|---|---|---|---|---| +| [`cb_base_data`](#api-cb-base-data) | 可转债基础数据 | `GET` | `api/v1/market/data/cb/cb-base-data` | `symbol_code` | `可转债基础数据.md` | +| [`cb_lists`](#api-cb-lists) | 可转债列表 | `GET` | `api/v1/market/data/cb/cb-lists` | - | `可转债列表.md` | ### 宏观经济 -| SDK 方法 | 接口名称 | HTTP | Path | 参数 | 状态 | 来源文档 | -|---|---|---|---|---|---|---| -| [`consumer_credit_monthly`](#api-consumer-credit-monthly) | 社融信贷 | `GET` | `api/v1/market/data/economic/china-credit-loans` | - | 可调用 | `社融信贷.md` | -| [`consumer_customs_trade_monthly`](#api-consumer-customs-trade-monthly) | 进出口 | `GET` | `api/v1/market/data/economic/china-customs-trade` | - | 可调用 | `进出口.md` | -| [`consumer_fiscal_revenue_monthly`](#api-consumer-fiscal-revenue-monthly) | 财政收入 | `GET` | `api/v1/market/data/economic/china-fiscal-revenue` | - | 可调用 | `财政收入.md` | -| [`consumer_fixed_asset_monthly`](#api-consumer-fixed-asset-monthly) | 固定资产投资 | `GET` | `api/v1/market/data/economic/china-fixed-asset-investment` | - | 可调用 | `固定资产投资.md` | -| [`consumer_forex_gold_monthly`](#api-consumer-forex-gold-monthly) | 外汇黄金 | `GET` | `api/v1/market/data/economic/china-forex-gold` | - | 可调用 | `外汇黄金.md` | -| [`consumer_gdp_quarterly`](#api-consumer-gdp-quarterly) | GDP | `GET` | `api/v1/market/data/economic/china-gdp` | - | 可调用 | `GDP.md` | -| [`consumer_industrial_added_value_monthly`](#api-consumer-industrial-added-value-monthly) | 工业增加值 | `GET` | `api/v1/market/data/economic/china-industrial-added-value` | - | 可调用 | `工业增加值.md` | -| [`consumer_money_supply_monthly`](#api-consumer-money-supply-monthly) | 货币供应 | `GET` | `api/v1/market/data/economic/china-money-supply` | - | 可调用 | `货币供应.md` | -| [`consumer_pmi_monthly`](#api-consumer-pmi-monthly) | PMI | `GET` | `api/v1/market/data/economic/china-pmi` | - | 可调用 | `PMI.md` | -| [`consumer_ppi_monthly`](#api-consumer-ppi-monthly) | PPI | `GET` | `api/v1/market/data/economic/china-ppi` | - | 可调用 | `PPI.md` | -| [`consumer_price_index_monthly`](#api-consumer-price-index-monthly) | CPI | `GET` | `api/v1/market/data/economic/china-cpi` | - | 可调用 | `CPI.md` | -| [`consumer_retail_sales_monthly`](#api-consumer-retail-sales-monthly) | 社零 | `GET` | `api/v1/market/data/economic/china-retail-sales` | - | 可调用 | `社零.md` | -| [`lpr_monthly`](#api-lpr-monthly) | LPR | `GET` | `api/v1/market/data/economic/china-lpr` | - | 可调用 | `LPR.md` | -| [`reserve_ratio_monthly`](#api-reserve-ratio-monthly) | 存款准备金率 | `GET` | `api/v1/market/data/economic/china-reserve-ratio` | - | 可调用 | `存款准备金率.md` | -| [`tax_revenue_monthly`](#api-tax-revenue-monthly) | 税收 | `GET` | `api/v1/market/data/economic/china-tax-revenue` | - | 可调用 | `税收.md` | -| [`us_economic`](#api-us-economic) | 美国经济指标 | `GET` | `api/v1/market/data/economic/us-economic` | `type` | 可调用 | `美国经济指标.md` | - -### 股票 - -| SDK 方法 | 接口名称 | HTTP | Path | 参数 | 状态 | 来源文档 | -|---|---|---|---|---|---|---| -| [`abnormal_trading_details`](#api-abnormal-trading-details) | 龙虎榜明细 | `GET` | `api/v1/market/data/abnormal-trading-details` | `date` | 可调用 | `龙虎榜明细.md` | -| [`abnormal_trading_overview`](#api-abnormal-trading-overview) | 龙虎榜总览 | `GET` | `api/v1/market/data/abnormal-trading-overview` | `date` | 可调用 | `龙虎榜总览.md` | -| [`auction_results`](#api-auction-results) | 集合竞价结果 | `GET` | `api/v1/market/data/auction-results` | `ts_code`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` | 可调用 | `集合竞价结果.md` | -| [`block_trades`](#api-block-trades) | 大宗交易 | `GET` | `api/v1/market/data/block-trades` | `date` | 可调用 | `大宗交易.md` | -| [`limit_down_pool`](#api-limit-down-pool) | 跌停池 | `GET` | `api/v1/market/data/limit-down-pool` | - | 可调用 | `跌停池.md` | -| [`limit_event_timeline_3s`](#api-limit-event-timeline-3s) | 涨跌停事件时间线 | `GET` | `api/v1/market/data/limit-event-timeline-3s` | `symbol` | 可调用 | `涨跌停事件时间线.md` | -| [`limit_up_break_pool`](#api-limit-up-break-pool) | 炸板池 | `GET` | `api/v1/market/data/limit-up-break-pool` | - | 可调用 | `炸板池.md` | -| [`limit_up_pool`](#api-limit-up-pool) | 涨停池 | `GET` | `api/v1/market/data/limit-up-pool` | - | 可调用 | `涨停池.md` | -| [`limit_up_pool_yesterday`](#api-limit-up-pool-yesterday) | 昨日涨停池 | `GET` | `api/v1/market/data/limit-up-pool-yesterday` | - | 可调用 | `昨日涨停池.md` | -| [`margin_trading_details`](#api-margin-trading-details) | 融资融券明细 | `GET` | `api/v1/market/data/margin-trading-details` | `date`, `page`, `page_size` | 可调用 | `融资融券明细.md` | -| [`margin_trading_details_paginated`](#api-margin-trading-details-paginated) | 融资融券明细分页 | `GET` | `api/v1/market/data/margin-trading-details` | `date`, `page`, `page_size` | 可调用 | `融资融券明细分页.md` | -| [`risk_warning_stock_quotes`](#api-risk-warning-stock-quotes) | 风险警示股行情 | `GET` | `api/v1/market/data/risk-warning-stocks/quotes` | `date` | 可调用 | `风险警示股行情.md` | -| [`risk_warning_stocks`](#api-risk-warning-stocks) | 风险警示股 | `GET` | `api/v1/market/data/risk-warning-stocks` | `date` | 可调用 | `风险警示股.md` | -| [`stk_limit`](#api-stk-limit) | 涨跌停价 | `GET` | `api/v1/market/data/stk-limit` | `instrument_type`, `symbol`, `symbol_id`, `market_id`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` | 可调用 | `涨跌停价.md` | -| [`stk_premarket`](#api-stk-premarket) | 盘前数据 | `GET` | `api/v1/market/data/stk-premarket` | `ts_code`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` | 可调用 | `盘前数据.md` | -| [`stock_adjust_factor`](#api-stock-adjust-factor) | 股票复权因子 | `GET` | `api/v1/market/data/stock-adjust-factor` | `symbol`, `trade_date`, `start_date`, `end_date`, `offset`, `limit` | 可调用 | `股票复权因子.md` | -| [`stock_announcements`](#api-stock-announcements) | 公告列表 | `GET` | `api/v1/market/data/announcements/stock-announcements` | `stock_code`, `start_date`, `end_date`, `type`, `page`, `page_size` | 可调用 | `公告列表.md` | -| [`stock_candlesticks`](#api-stock-candlesticks) | 股票K线 | `POST` | `api/v1/market/data/stock-candlesticks` | `symbol`, `interval_unit`, `interval_value`, `adjust_kind`, `since_ts_millis`, `until_ts_millis`, `limit` | 可调用 | `股票K线.md` | -| [`stock_candlesticks_batch`](#api-stock-candlesticks-batch) | 批量股票K线 | `POST` | `api/v1/market/data/stock-candlesticks/batch` | `symbols`, `interval_unit`, `interval_value`, `adjust_kind`, `since_ts_millis`, `until_ts_millis`, `limit` | 可调用 | `批量股票K线.md` | -| [`stock_capital_flows`](#api-stock-capital-flows) | 股票资金流向 | `GET` | `api/v1/market/data/stock-capital-flows` | `date`, `page`, `page_size` | 可调用 | `股票资金流向.md` | -| [`stock_capital_flows_paginated`](#api-stock-capital-flows-paginated) | 股票资金流向 | `GET` | `api/v1/market/data/stock-capital-flows` | `date`, `page`, `page_size` | 可调用 | `股票资金流向.md` | -| [`stock_comment_desire_em`](#api-stock-comment-desire-em) | 千股千评意愿度 | `GET` | `api/v1/market/data/stock-comment/desire` | `symbol` | 可调用 | `千股千评意愿度.md` | -| [`stock_comment_em`](#api-stock-comment-em) | 千股千评 | `GET` | `api/v1/market/data/stock-comment/index` | `page`, `page_size` | 可调用 | `千股千评.md` | -| [`stock_comment_focus_em`](#api-stock-comment-focus-em) | 千股千评关注度 | `GET` | `api/v1/market/data/stock-comment/focus` | `symbol` | 可调用 | `千股千评关注度.md` | -| [`stock_comment_org_participate_em`](#api-stock-comment-org-participate-em) | 机构参与度 | `GET` | `api/v1/market/data/stock-comment/org-participate` | `symbol` | 可调用 | `机构参与度.md` | -| [`stock_comment_score_em`](#api-stock-comment-score-em) | 千股千评评分 | `GET` | `api/v1/market/data/stock-comment/score` | `symbol` | 可调用 | `千股千评评分.md` | -| [`stock_dividends_paginated`](#api-stock-dividends-paginated) | 股票分红记录分页 | `GET` | `api/v1/market/data/dividends` | `page`, `page_size` | 可调用 | `股票分红记录分页.md` | -| [`stock_filter`](#api-stock-filter) | 股票筛选 | `GET` | `api/v1/market/data/stock-list/filter` | `board`, `listing_date_since`, `page`, `page_size` | 可调用 | `股票筛选.md` | -| [`stock_institution_holdings`](#api-stock-institution-holdings) | 机构持股 | `GET` | `api/v1/market/data/share/stock-institution-holdings` | `year`, `report_type`, `inst_type`, `page`, `page_size` | 可调用 | `机构持股.md` | -| [`stock_institution_holdings_detail`](#api-stock-institution-holdings-detail) | 机构持股明细 | `GET` | `api/v1/market/data/share/stock-institution-holdings-detail` | `stock_code`, `year`, `report_type`, `inst_type`, `page`, `page_size` | 可调用 | `机构持股明细.md` | -| [`stock_institution_share_holdings`](#api-stock-institution-share-holdings) | 机构股本持股 | `GET` | `api/v1/market/data/institution/institution-share-holdings` | `institution_id`, `year`, `report_type`, `invest_type` | 可调用 | `机构股本持股.md` | -| [`stock_intraday`](#api-stock-intraday) | 股票日内分时 | `GET` | `api/v1/market/security/{symbol}/intraday` | `symbol` | 可调用 | `股票日内分时.md` | -| [`stock_intraday_auction_volume`](#api-stock-intraday-auction-volume) | 集合竞价成交量 | `GET` | `api/v1/market/data/intraday-auction-volume` | `trade_date`, `page`, `page_size` | 可调用 | `集合竞价成交量.md` | -| [`stock_intraday_auction_volume_symbol`](#api-stock-intraday-auction-volume-symbol) | 单标的集合竞价成交量 | `GET` | `api/v1/market/data/intraday-auction-volume/symbol` | `symbol`, `trade_date`, `page`, `page_size` | 可调用 | `单标的集合竞价成交量.md` | -| [`stock_ipos`](#api-stock-ipos) | 股票IPO | `GET` | `api/v1/market/data/stock-ipos` | `page`, `page_size` | 可调用 | `股票IPO.md` | -| [`stock_ipos_paginated`](#api-stock-ipos-paginated) | 股票IPO分页 | `GET` | `api/v1/market/data/stock-ipos` | `page`, `page_size` | 可调用 | `股票IPO分页.md` | -| [`stock_list`](#api-stock-list) | 股票列表 | `GET` | `api/v1/market/data/stock-list` | - | 可调用 | `股票列表.md` | -| [`stock_market`](#api-stock-market) | 股票市场行情 | `GET` | `api/v1/market/data/daec/market/snapshot` | `scope` | 可调用 | `股票市场行情.md` | -| [`stock_market_distribution_intraday`](#api-stock-market-distribution-intraday) | 市场涨跌分布分时 | `GET` | `api/v1/market/data/daec/market/distribution-history` | `scope` | 可调用 | `市场涨跌分布分时.md` | -| [`stock_prev_close`](#api-stock-prev-close) | 股票前收盘价 | `GET` | `api/v1/market/data/daec/history/prev-closes` | `symbol`, `since`, `until` | 可调用 | `股票前收盘价.md` | -| [`stock_rating_top5`](#api-stock-rating-top5) | 飞兔股票评级Top5 | `GET` | `api/v1/market/data/feitu/stock-rating-top5` | `date`, `variant`, `type` | 可调用 | `飞兔股票评级Top5.md` | -| [`stock_related`](#api-stock-related) | 相关股票 | `GET` | `api/v1/market/security/{symbol}/related` | `symbol`, `limit` | 可调用 | `相关股票.md` | -| [`stock_reports`](#api-stock-reports) | 研报列表 | `GET` | `api/v1/market/data/report/stock-reports` | `stock_code`, `start_date`, `end_date`, `type`, `page`, `page_size` | 可调用 | `研报列表.md` | -| [`stock_share`](#api-stock-share) | 股本 | `GET` | `api/v1/market/data/share/get-stock-share` | `stock_code`, `date` | 可调用 | `股本.md` | -| [`stock_signal_latest_snapshot`](#api-stock-signal-latest-snapshot) | 信号最新快照 | `GET` | `api/v1/market/data/stock-signal-latest-snapshot` | `signal_type`, `page`, `page_size` | 可调用 | `信号最新快照.md` | -| [`stock_trade`](#api-stock-trade) | 股票分时成交 | `GET` | `api/v1/market/data/daec/history/trades` | `symbol` | 可调用 | `股票分时成交.md` | -| [`stock_unlock`](#api-stock-unlock) | 限售解禁 | `GET` | `api/v1/market/data/unlock/stock-unlock` | `stock_code`, `page`, `page_size` | 可调用 | `限售解禁.md` | -| [`stock_unlock_by_date`](#api-stock-unlock-by-date) | 限售解禁按日期 | `GET` | `api/v1/market/data/unlock/stock-unlock-by-date` | `start_date`, `end_date`, `page`, `page_size` | 可调用 | `限售解禁按日期.md` | -| [`suspension_list`](#api-suspension-list) | 停牌列表 | `GET` | `api/v1/market/data/suspension-list` | `trade_date`, `page`, `page_size` | 可调用 | `停牌列表.md` | - -### 市场与其他 - -| SDK 方法 | 接口名称 | HTTP | Path | 参数 | 状态 | 来源文档 | -|---|---|---|---|---|---|---| -| [`bse_mapping`](#api-bse-mapping) | 北交所映射 | `GET` | `api/v1/market/data/bse-mapping` | `o_code`, `n_code` | 可调用 | `北交所映射.md` | -| [`bullion_price`](#api-bullion-price) | 贵金属价格 | `GET` | `api/v1/market/data/bullion/price` | `symbol`, `start_date`, `end_date`, `page`, `page_size` | 可调用 | `贵金属价格.md` | -| [`bullion_support_symbol`](#api-bullion-support-symbol) | 贵金属支持标的 | `GET` | `api/v1/market/data/bullion/support-symbol` | - | 可调用 | `贵金属支持标的.md` | -| [`cb_base_data`](#api-cb-base-data) | 可转债基础数据 | `GET` | `api/v1/market/data/cb/cb-base-data` | `symbol_code` | 可调用 | `可转债基础数据.md` | -| [`cb_lists`](#api-cb-lists) | 可转债列表 | `GET` | `api/v1/market/data/cb/cb-lists` | - | 可调用 | `可转债列表.md` | -| [`company_list`](#api-company-list) | 公司列表 | `GET` | `api/v1/market/data/company-list` | `stock_name`, `stock_code`, `page`, `page_size` | 可调用 | `公司列表.md` | -| [`eastmoney_board_constituents`](#api-eastmoney-board-constituents) | 东方财富板块成份股 | `GET` | `api/v1/market/data/eastmoney-board-constituents` | `board_code` | 可调用 | `东方财富板块成份股.md` | -| [`eastmoney_board_daily_kline`](#api-eastmoney-board-daily-kline) | 东方财富板块日线OHLC | `GET` | `api/v1/market/data/eastmoney-board-daily-ohlc` | `board_code`, `start_date`, `end_date`, `page`, `page_size` | 可调用 | `东方财富板块日线OHLC.md` | -| [`eastmoney_board_latest_kline`](#api-eastmoney-board-latest-kline) | 东方财富板块最新OHLC | `GET` | `api/v1/market/data/eastmoney-board-latest-ohlc` | `board_code`, `page`, `page_size` | 可调用 | `东方财富板块最新OHLC.md` | -| [`eastmoney_concept_boards`](#api-eastmoney-concept-boards) | 东方财富概念板块 | `GET` | `api/v1/market/data/eastmoney-concept-boards` | - | 可调用 | `东方财富概念板块.md` | -| [`eastmoney_dapan_flow`](#api-eastmoney-dapan-flow) | 东方财富大盘资金流 | `GET` | `api/v1/market/data/eastmoney-dapan-flow` | `trade_date`, `start_date`, `end_date`, `page`, `page_size` | 可调用 | `东方财富大盘资金流.md` | -| [`eastmoney_hk_index_daily_kline`](#api-eastmoney-hk-index-daily-kline) | 东方财富港股指数日K | `GET` | `api/v1/market/data/eastmoney-hk-index-daily-kline` | `index_code`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` | 可调用 | `东方财富港股指数日K.md` | -| [`eastmoney_market_valuation`](#api-eastmoney-market-valuation) | 东方财富市场估值 | `GET` | `api/v1/market/data/eastmoney-market-valuation` | `market_code`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` | 可调用 | `东方财富市场估值.md` | -| [`eastmoney_rank`](#api-eastmoney-rank) | 东方财富股票排名 | `GET` | `api/v1/market/data/eastmoney-rank` | `rank_group`, `market`, `trade_date` | 可调用 | `东方财富股票排名.md` | -| [`eastmoney_sector_flow`](#api-eastmoney-sector-flow) | 东方财富板块资金流 | `GET` | `api/v1/market/data/eastmoney-sector-flow` | `sector_code`, `sector_type`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` | 可调用 | `东方财富板块资金流.md` | -| [`eastmoney_stock_flow`](#api-eastmoney-stock-flow) | 东方财富个股资金流 | `GET` | `api/v1/market/data/eastmoney-stock-flow` | `symbol`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` | 可调用 | `东方财富个股资金流.md` | -| [`eastmoney_stock_valuation`](#api-eastmoney-stock-valuation) | 东方财富个股估值 | `GET` | `api/v1/market/data/eastmoney-stock-valuation` | `symbol`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` | 可调用 | `东方财富个股估值.md` | -| [`eastmoney_us_stock_daily_kline`](#api-eastmoney-us-stock-daily-kline) | 东方财富美股日OHLC | `GET` | `api/v1/market/data/eastmoney-us-stock-daily-ohlc` | `stock_code`, `start_date`, `end_date`, `page`, `page_size` | 可调用 | `东方财富美股日OHLC.md` | -| [`eastmoney_us_stock_daily_ohlc`](#api-eastmoney-us-stock-daily-ohlc) | 东方财富美股日OHLC | `GET` | `api/v1/market/data/eastmoney-us-stock-daily-ohlc` | `stock_code`, `start_date`, `end_date`, `page`, `page_size` | 可调用 | `东方财富美股日OHLC.md` | -| [`eastmoney_us_stock_latest_kline`](#api-eastmoney-us-stock-latest-kline) | 东方财富美股最新OHLC | `GET` | `api/v1/market/data/eastmoney-us-stock-latest-ohlc` | `stock_code`, `page`, `page_size` | 可调用 | `东方财富美股最新OHLC.md` | -| [`eastmoney_us_stock_latest_ohlc`](#api-eastmoney-us-stock-latest-ohlc) | 东方财富美股最新OHLC | `GET` | `api/v1/market/data/eastmoney-us-stock-latest-ohlc` | `stock_code`, `page`, `page_size` | 可调用 | `东方财富美股最新OHLC.md` | -| [`eastmoney_us_stock_list`](#api-eastmoney-us-stock-list) | 东方财富美股列表 | `GET` | `api/v1/market/data/eastmoney-us-stock-list` | `refresh`, `page`, `page_size` | 可调用 | `东方财富美股列表.md` | -| [`hk_sh_stock_connect_members`](#api-hk-sh-stock-connect-members) | 沪港通成份 | `GET` | `api/v1/market/data/hk-sh-stock-connect-members` | - | 可调用 | `沪港通成份.md` | -| [`hk_sz_stock_connect_members`](#api-hk-sz-stock-connect-members) | 深港通成份 | `GET` | `api/v1/market/data/hk-sz-stock-connect-members` | - | 可调用 | `深港通成份.md` | -| [`index_description_all`](#api-index-description-all) | 指数基础信息 | `GET` | `api/v1/market/data/index-description-all` | - | 可调用 | `指数基础信息.md` | -| [`northbound`](#api-northbound) | 北向资金交易 | `GET` | `api/v1/market/data/northbound` | `date` | 可调用 | `北向资金交易.md` | -| [`nth_trade_date`](#api-nth-trade-date) | 第N个交易日 | `GET` | `api/v1/market/data/time/get-nth-trade-date` | `n` | 可调用 | `第N个交易日.md` | -| [`price_change`](#api-price-change) | 价格变动 | `GET` | `api/v1/market/data/price/get-price-change` | `stock_code`, `base_date`, `n`, `direction` | 可调用 | `价格变动.md` | -| [`search`](#api-search) | 标的搜索 | `GET` | `api/v1/market/security/search` | `query`, `limit` | 可调用 | `标的搜索.md` | -| [`semantic_search_news`](#api-semantic-search-news) | 新闻语义搜索 | `GET` | `api/v1/market/data/semantic-search-news` | `query`, `limit`, `year`, `start_time`, `end_time` | 可调用 | `新闻语义搜索.md` | -| [`sh_hk_stock_connect_members`](#api-sh-hk-stock-connect-members) | 沪股通成份 | `GET` | `api/v1/market/data/sh-hk-stock-connect-members` | - | 可调用 | `沪股通成份.md` | -| [`southbound`](#api-southbound) | 南向资金交易 | `GET` | `api/v1/market/data/southbound` | `date` | 可调用 | `南向资金交易.md` | -| [`sw_industry_constituent_history`](#api-sw-industry-constituent-history) | 申万行业成份股历史 | `GET` | `api/v1/market/data/sw-industry/constituent-history` | `industry_code` | 可调用 | `申万行业成份股历史.md` | -| [`sw_industry_daily_metrics`](#api-sw-industry-daily-metrics) | 申万行业日度指标 | `GET` | `api/v1/market/data/sw-industry/daily-metrics` | `level`, `start_date`, `end_date`, `industry_code`, `page`, `page_size` | 可调用 | `申万行业日度指标.md` | -| [`sw_industry_overview`](#api-sw-industry-overview) | 申万行业总览 | `GET` | `api/v1/market/data/sw-industry/overview` | `date`, `level`, `page`, `page_size` | 可调用 | `申万行业总览.md` | -| [`sz_hk_stock_connect_members`](#api-sz-hk-stock-connect-members) | 深股通成份 | `GET` | `api/v1/market/data/sz-hk-stock-connect-members` | - | 可调用 | `深股通成份.md` | -| [`ths_all_board_kline`](#api-ths-all-board-kline) | 同花顺全板块K线 | `GET` | `api/v1/market/data/ths-all-board-kline` | `start_date`, `end_date`, `page`, `page_size` | 可调用 | `同花顺全板块K线.md` | -| [`ths_board_kline`](#api-ths-board-kline) | 同花顺板块K线 | `GET` | `api/v1/market/data/ths-board-kline` | `board_code`, `page`, `page_size` | 可调用 | `同花顺板块K线.md` | -| [`ths_board_list`](#api-ths-board-list) | 同花顺板块列表 | `GET` | `api/v1/market/data/ths-board-list` | - | 可调用 | `同花顺板块列表.md` | -| [`type_reports`](#api-type-reports) | 研报分类 | `GET` | `api/v1/market/data/report/type-reports` | `rept_type`, `start_date`, `end_date`, `page`, `page_size` | 可调用 | `研报分类.md` | -| [`us_balance`](#api-us-balance) | 美股资产负债表 | `GET` | `api/v1/market/data/us/us-balance` | `stock_code`, `period`, `report_type`, `start_date`, `end_date`, `page`, `page_size` | 可调用 | `美股资产负债表.md` | -| [`us_basic`](#api-us-basic) | 美股基础信息 | `GET` | `api/v1/market/data/us/us-basic` | `stock_code`, `page`, `page_size` | 可调用 | `美股基础信息.md` | -| [`us_cashflow`](#api-us-cashflow) | 美股现金流 | `GET` | `api/v1/market/data/us/us-cashflow` | `stock_code`, `period`, `report_type`, `start_date`, `end_date`, `page`, `page_size` | 可调用 | `美股现金流.md` | -| [`us_income`](#api-us-income) | 美股利润表 | `GET` | `api/v1/market/data/us/us-income` | `stock_code`, `period`, `report_type`, `start_date`, `end_date`, `page`, `page_size` | 可调用 | `美股利润表.md` | -| [`xueqiu_rank`](#api-xueqiu-rank) | 雪球股票排名 | `GET` | `api/v1/market/data/xueqiu-rank` | `rank_group`, `period`, `trade_date`, `page`, `page_size` | 可调用 | `雪球股票排名.md` | -| [`yzxdr_detail`](#api-yzxdr-detail) | 除权除息明细 | `GET` | `api/v1/market/data/yzxdr-detail` | `year`, `quarter`, `stock_code`, `page`, `page_size` | 可调用 | `除权除息明细.md` | - -### ETF - -| SDK 方法 | 接口名称 | HTTP | Path | 参数 | 状态 | 来源文档 | -|---|---|---|---|---|---|---| -| [`etf_adjust_factor`](#api-etf-adjust-factor) | ETF复权因子 | `GET` | `api/v1/market/data/etf-adjust-factor` | `symbol`, `trade_date`, `start_date`, `end_date`, `offset`, `limit` | 可调用 | `ETF复权因子.md` | -| [`etf_components`](#api-etf-components) | ETF成份股 | `GET` | `api/v1/market/data/etf-component` | `symbol` | 可调用 | `ETF成份股.md` | -| [`etf_components_all`](#api-etf-components-all) | ETF成份列表 | `GET` | `api/v1/market/data/etf-components-all` | - | 可调用 | `ETF成份列表.md` | -| [`etf_description_all`](#api-etf-description-all) | ETF基础信息 | `GET` | `api/v1/market/data/etf-description-all` | - | 可调用 | `ETF基础信息.md` | -| [`etf_fund_export`](#api-etf-fund-export) | 指数ETF基金导出 | `GET` | `api/v1/market/data/etf/zhitou-etf` | `request_id`, `page`, `page_size` | 可调用 | `指数ETF基金导出.md` | -| [`etf_pcf_list`](#api-etf-pcf-list) | ETF-PCF清单列表 | `GET` | `api/v1/market/data/etf-pcf/etf-pcfs` | `date`, `page`, `page_size` | 可调用 | `ETF-PCF清单列表.md` | -| [`etf_pre`](#api-etf-pre) | ETF盘前数据 | `GET` | `api/v1/market/data/etf-pre-data` | `date` | 可调用 | `ETF盘前数据.md` | -| [`etf_pre_single`](#api-etf-pre-single) | 单只ETF盘前数据 | `GET` | `api/v1/market/data/etf-pre-single` | `symbol`, `date` | 可调用 | `单只ETF盘前数据.md` | - -### 指数 - -| SDK 方法 | 接口名称 | HTTP | Path | 参数 | 状态 | 来源文档 | -|---|---|---|---|---|---|---| -| [`index_description_list`](#api-index-description-list) | 中证指数描述列表 | `GET` | `api/v1/market/data/index/index_description` | `page`, `page_size` | 可调用 | `中证指数描述列表.md` | -| [`index_weight_list`](#api-index-weight-list) | 指数权重列表 | `GET` | `api/v1/market/data/index/index_weight` | `index_code`, `date`, `page`, `page_size` | 可调用 | `指数权重列表.md` | -| [`index_weight_summary`](#api-index-weight-summary) | 指数权重汇总 | `GET` | `api/v1/market/data/index/index_weight_summary` | `page`, `page_size` | 可调用 | `指数权重汇总.md` | - -### 港股 - -| SDK 方法 | 接口名称 | HTTP | Path | 参数 | 状态 | 来源文档 | -|---|---|---|---|---|---|---| -| [`company_hk`](#api-company-hk) | 港股公司信息 | `GET` | `api/v1/market/data/hk/company-hk` | `trade_code` | 可调用 | `港股公司信息.md` | -| [`hk_balance_bank`](#api-hk-balance-bank) | 港股资产负债表 | `GET` | `api/v1/market/data/hk/hk-balance-bank` | `trade_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` | 可调用 | `港股资产负债表.md` | -| [`hk_balance_gene`](#api-hk-balance-gene) | 港股资产负债表 | `GET` | `api/v1/market/data/hk/hk-balance-gene` | `trade_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` | 可调用 | `港股资产负债表.md` | -| [`hk_balance_insur`](#api-hk-balance-insur) | 港股资产负债表 | `GET` | `api/v1/market/data/hk/hk-balance-insur` | `trade_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` | 可调用 | `港股资产负债表.md` | -| [`hk_basinfo_get`](#api-hk-basinfo-get) | 港股个股信息 | `GET` | `api/v1/market/data/hk/hk-view` | `hk_code` | 可调用 | `港股个股信息.md` | -| [`hk_basinfo_post`](#api-hk-basinfo-post) | 港股个股信息 | `GET` | `api/v1/market/data/hk/hk-view` | `hk_code` | 可调用 | `港股个股信息.md` | -| [`hk_candlesticks`](#api-hk-candlesticks) | 港股K线 | `GET` | `api/v1/market/data/hk/hk-candlesticks` | `trade_code`, `interval_unit`, `until_date`, `since_date`, `interval_value`, `limit`, `adjust_kind` | 可调用 | `港股K线.md` | -| [`hk_cashflow`](#api-hk-cashflow) | 港股现金流量表 | `GET` | `api/v1/market/data/hk/hk-cashflow` | `stock_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` | 可调用 | `港股现金流量表.md` | -| [`hk_income_bank`](#api-hk-income-bank) | 港股利润表 | `GET` | `api/v1/market/data/hk/hk-income-bank` | `trade_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` | 可调用 | `港股利润表.md` | -| [`hk_income_gene`](#api-hk-income-gene) | 港股利润表 | `GET` | `api/v1/market/data/hk/hk-income-gene` | `trade_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` | 可调用 | `港股利润表.md` | -| [`hk_income_insur`](#api-hk-income-insur) | 港股利润表 | `GET` | `api/v1/market/data/hk/hk-income-insur` | `trade_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` | 可调用 | `港股利润表.md` | -| [`hk_valuatnanalyd`](#api-hk-valuatnanalyd) | 港股估值分析 | `GET` | `api/v1/market/data/hk/hk-valuatnanalyd` | `trade_code`, `page`, `page_size` | 可调用 | `港股估值分析.md` | -| [`market_cap_hk`](#api-market-cap-hk) | 港股市值 | `GET` | `api/v1/market/data/hk/market-cap-hk` | `trade_code` | 可调用 | `港股市值.md` | -| [`stk_ah_comparison`](#api-stk-ah-comparison) | AH股对比 | `GET` | `api/v1/market/data/hk/stk-ah-comparison` | `hk_code`, `ts_code`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` | 可调用 | `AH股对比.md` | - -### 基金 - -| SDK 方法 | 接口名称 | HTTP | Path | 参数 | 状态 | 来源文档 | -|---|---|---|---|---|---|---| -| [`fund_basicinfo`](#api-fund-basicinfo) | 基金基础信息 | `GET` | `api/v1/market/data/fund/fund-basicinfo` | `institution_code`, `page`, `page_size` | 可调用 | `基金基础信息.md` | -| [`fund_cal_return`](#api-fund-cal-return) | 基金收益 | `GET` | `api/v1/market/data/fund/fund-cal-return` | `institution_code`, `cal-type` | 可调用 | `基金收益.md` | -| [`fund_nav`](#api-fund-nav) | 基金净值 | `GET` | `api/v1/market/data/fund/fund-nav` | `institution_code`, `page`, `page_size` | 可调用 | `基金净值.md` | -| [`fund_overview`](#api-fund-overview) | 基金总览 | `GET` | `api/v1/market/data/fund/fund-overview` | `page`, `page_size` | 可调用 | `基金总览.md` | -| [`fund_support_symbols`](#api-fund-support-symbols) | 基金支持标的 | `GET` | `api/v1/market/data/fund/fund-support-symbols` | `page`, `page_size` | 可调用 | `基金支持标的.md` | - -### 期货 - -| SDK 方法 | 接口名称 | HTTP | Path | 参数 | 状态 | 来源文档 | -|---|---|---|---|---|---|---| -| [`china_futures_base_data`](#api-china-futures-base-data) | 中国期货基础数据 | `GET` | `api/v1/market/data/futures/futures-base-data` | `trade_date`, `symbol` | 可调用 | `中国期货基础数据.md` | -| [`china_futures_lists`](#api-china-futures-lists) | 中国期货列表 | `GET` | `api/v1/market/data/futures/futures-lists` | `trade_date` | 可调用 | `中国期货列表.md` | -| [`eastmoney_futures_position`](#api-eastmoney-futures-position) | 东方财富期货持仓 | `GET` | `api/v1/market/data/eastmoney-futures-position` | `exchange`, `variety_code`, `contract_code`, `trade_date`, `start_date`, `end_date`, `member_name_abbr`, `page`, `page_size` | 可调用 | `东方财富期货持仓.md` | -| [`eastmoney_futures_strange`](#api-eastmoney-futures-strange) | 东方财富期货持仓 | `GET` | `api/v1/market/data/eastmoney-futures-position` | `exchange`, `variety_code`, `contract_code`, `trade_date`, `start_date`, `end_date`, `member_name_abbr`, `page`, `page_size` | 可调用 | `东方财富期货持仓.md` | -| [`futures_contract_kline`](#api-futures-contract-kline) | 期货合约K线 | `GET` | `api/v1/market/data/futures/kline` | `symbol`, `interval`, `start`, `end`, `limit` | 可调用 | `期货合约K线.md` | -| [`futures_kline`](#api-futures-kline) | 期货合约K线 | `GET` | `api/v1/market/data/futures/kline` | `symbol`, `interval`, `start`, `end`, `limit` | 可调用 | `期货合约K线.md` | - -### 股东持股 - -| SDK 方法 | 接口名称 | HTTP | Path | 参数 | 状态 | 来源文档 | -|---|---|---|---|---|---|---| -| [`stock_float_holders`](#api-stock-float-holders) | 十大流通股东 | `GET` | `api/v1/market/data/holder/stock-holder-ften` | `stock_code`, `is_last`, `page`, `page_size` | 可调用 | `十大流通股东.md` | -| [`stock_ggcg_em`](#api-stock-ggcg-em) | 东方财富股东增减持 | `GET` | `api/v1/market/data/holder/stock-ggcg-em` | `symbol`, `page`, `page_size` | 可调用 | `东方财富股东增减持.md` | -| [`stock_ggmx`](#api-stock-ggmx) | 董监高持股变动 | `GET` | `api/v1/market/data/holder/stock-ggmx` | `stock_code`, `change_direction`, `start_date`, `end_date`, `page`, `page_size` | 可调用 | `董监高持股变动.md` | -| [`stock_ggmx_buy_ranking`](#api-stock-ggmx-buy-ranking) | 董监高增持排名 | `GET` | `api/v1/market/data/holder/stock-ggmx-buy-ranking` | `time_range`, `page`, `page_size` | 可调用 | `董监高增持排名.md` | -| [`stock_ggmx_sell_ranking`](#api-stock-ggmx-sell-ranking) | 董监高减持排名 | `GET` | `api/v1/market/data/holder/stock-ggmx-sell-ranking` | `time_range`, `page`, `page_size` | 可调用 | `董监高减持排名.md` | -| [`stock_holders`](#api-stock-holders) | 十大股东 | `GET` | `api/v1/market/data/holder/stock-holder-ten` | `stock_code`, `is_last`, `page`, `page_size` | 可调用 | `十大股东.md` | -| [`stock_holders_number`](#api-stock-holders-number) | 股东人数 | `GET` | `api/v1/market/data/holder/stock-holder-nums` | `stock_code`, `is_last`, `page`, `page_size` | 可调用 | `股东人数.md` | -| [`stock_share_chg`](#api-stock-share-chg) | 股东增减持 | `GET` | `api/v1/market/data/holder/stock-share-chg` | `stock_code`, `is_last`, `page`, `page_size` | 可调用 | `股东增减持.md` | - -### 股权质押 - -| SDK 方法 | 接口名称 | HTTP | Path | 参数 | 状态 | 来源文档 | -|---|---|---|---|---|---|---| -| [`pledge_summary`](#api-pledge-summary) | 股权质押汇总 | `GET` | `api/v1/market/data/pledge/pledge-summary` | `page`, `page_size` | 可调用 | `股权质押汇总.md` | -| [`stock_pledge_detail`](#api-stock-pledge-detail) | 股权质押明细 | `GET` | `api/v1/market/data/pledge/pledge-detail` | `stock_code`, `is_last`, `page`, `page_size` | 可调用 | `股权质押明细.md` | -| [`stock_pledge_summary`](#api-stock-pledge-summary) | 股权质押汇总 | `GET` | `api/v1/market/data/pledge/pledge-summary` | `page`, `page_size` | 可调用 | `股权质押汇总.md` | - -### 公司治理 - -| SDK 方法 | 接口名称 | HTTP | Path | 参数 | 状态 | 来源文档 | -|---|---|---|---|---|---|---| -| [`major_contract`](#api-major-contract) | 重大合同 | `GET` | `api/v1/market/data/corporate/contract` | `start_date`, `end_date` | 可调用 | `重大合同.md` | -| [`major_contract_by_symbol`](#api-major-contract-by-symbol) | 重大合同按标的 | `GET` | `api/v1/market/data/corporate/contract/by-symbol` | `symbol`, `page`, `page_size` | 可调用 | `重大合同按标的.md` | -| [`major_contract_summary`](#api-major-contract-summary) | 重大合同汇总 | `GET` | `api/v1/market/data/corporate/contract/summary` | `page`, `page_size` | 可调用 | `重大合同汇总.md` | -| [`shareholders_meeting`](#api-shareholders-meeting) | 股东大会 | `GET` | `api/v1/market/data/corporate/meeting` | `page`, `page_size` | 可调用 | `股东大会.md` | - -### 商誉 - -| SDK 方法 | 接口名称 | HTTP | Path | 参数 | 状态 | 来源文档 | -|---|---|---|---|---|---|---| -| [`goodwill_industry`](#api-goodwill-industry) | 商誉行业 | `GET` | `api/v1/market/data/goodwill/industry` | `date`, `page`, `page_size` | 可调用 | `商誉行业.md` | -| [`goodwill_market_overview`](#api-goodwill-market-overview) | 商誉市场总览 | `GET` | `api/v1/market/data/goodwill/market-overview` | - | 可调用 | `商誉市场总览.md` | -| [`goodwill_predict`](#api-goodwill-predict) | 商誉预测 | `GET` | `api/v1/market/data/goodwill/predict` | `date`, `page`, `page_size` | 可调用 | `商誉预测.md` | -| [`goodwill_stock_detail`](#api-goodwill-stock-detail) | 商誉个股明细 | `GET` | `api/v1/market/data/goodwill/stock-detail` | `date`, `page`, `page_size` | 可调用 | `商誉个股明细.md` | -| [`goodwill_stock_impairment`](#api-goodwill-stock-impairment) | 商誉减值 | `GET` | `api/v1/market/data/goodwill/stock-impairment` | `date`, `page`, `page_size` | 可调用 | `商誉减值.md` | - -### 全球指数 - -| SDK 方法 | 接口名称 | HTTP | Path | 参数 | 状态 | 来源文档 | -|---|---|---|---|---|---|---| -| [`global_index_daily_kline`](#api-global-index-daily-kline) | 全球指数日K线 | `GET` | `api/v1/market/data/global-index/daily-kline` | `secid`, `start_date`, `end_date` | 可调用 | `全球指数日K线.md` | +| SDK 方法 | 接口名称 | HTTP | Path | 参数 | 来源文档 | +|---|---|---|---|---|---| +| [`baidu_financial_calendar`](#api-baidu-financial-calendar) | 百度财经日历 | `GET` | `api/v1/market/data/finance/financial-calendar/baidu` | `start_date`, `end_date`, `category`, `page`, `page_size` | `百度财经日历.md` | +| [`consumer_credit_monthly`](#api-consumer-credit-monthly) | 社融信贷 | `GET` | `api/v1/market/data/economic/china-credit-loans` | - | `社融信贷.md` | +| [`consumer_customs_trade_monthly`](#api-consumer-customs-trade-monthly) | 进出口 | `GET` | `api/v1/market/data/economic/china-customs-trade` | - | `进出口.md` | +| [`consumer_fiscal_revenue_monthly`](#api-consumer-fiscal-revenue-monthly) | 财政收入 | `GET` | `api/v1/market/data/economic/china-fiscal-revenue` | - | `财政收入.md` | +| [`consumer_fixed_asset_monthly`](#api-consumer-fixed-asset-monthly) | 固定资产投资 | `GET` | `api/v1/market/data/economic/china-fixed-asset-investment` | - | `固定资产投资.md` | +| [`consumer_gdp_quarterly`](#api-consumer-gdp-quarterly) | GDP | `GET` | `api/v1/market/data/economic/china-gdp` | - | `GDP.md` | +| [`consumer_industrial_added_value_monthly`](#api-consumer-industrial-added-value-monthly) | 工业增加值 | `GET` | `api/v1/market/data/economic/china-industrial-added-value` | - | `工业增加值.md` | +| [`consumer_money_supply_monthly`](#api-consumer-money-supply-monthly) | 货币供应 | `GET` | `api/v1/market/data/economic/china-money-supply` | - | `货币供应.md` | +| [`consumer_pmi_monthly`](#api-consumer-pmi-monthly) | PMI | `GET` | `api/v1/market/data/economic/china-pmi` | - | `PMI.md` | +| [`consumer_ppi_monthly`](#api-consumer-ppi-monthly) | PPI | `GET` | `api/v1/market/data/economic/china-ppi` | - | `PPI.md` | +| [`consumer_price_index_monthly`](#api-consumer-price-index-monthly) | CPI | `GET` | `api/v1/market/data/economic/china-cpi` | - | `CPI.md` | +| [`consumer_retail_sales_monthly`](#api-consumer-retail-sales-monthly) | 社零 | `GET` | `api/v1/market/data/economic/china-retail-sales` | - | `社零.md` | +| [`lpr_monthly`](#api-lpr-monthly) | LPR | `GET` | `api/v1/market/data/economic/china-lpr` | - | `LPR.md` | +| [`reserve_ratio_monthly`](#api-reserve-ratio-monthly) | 存款准备金率 | `GET` | `api/v1/market/data/economic/china-reserve-ratio` | - | `存款准备金率.md` | +| [`tax_revenue_monthly`](#api-tax-revenue-monthly) | 税收 | `GET` | `api/v1/market/data/economic/china-tax-revenue` | - | `税收.md` | +| [`us_economic`](#api-us-economic) | 美国经济指标 | `GET` | `api/v1/market/data/economic/us-economic` | `type` | `美国经济指标.md` | +| [`wallstreetcn_financial_calendar`](#api-wallstreetcn-financial-calendar) | 华尔街见闻财经日历 | `GET` | `api/v1/market/data/finance/financial-calendar/wallstreetcn` | `start_date`, `end_date`, `page`, `page_size` | `华尔街见闻财经日历.md` | + +### 大模型语料 + +| SDK 方法 | 接口名称 | HTTP | Path | 参数 | 来源文档 | +|---|---|---|---|---|---| +| [`semantic_search_news`](#api-semantic-search-news) | 新闻语义搜索 | `GET` | `api/v1/market/data/semantic-search-news` | `query`, `limit`, `year`, `start_time`, `end_time` | `新闻语义搜索.md` | +| [`shareholders_meeting`](#api-shareholders-meeting) | 股东大会 | `GET` | `api/v1/market/data/corporate/meeting` | `page`, `page_size` | `股东大会.md` | +| [`stock_announcements`](#api-stock-announcements) | 公告列表 | `GET` | `api/v1/market/data/announcements/stock-announcements` | `stock_code`, `start_date`, `end_date`, `type`, `page`, `page_size` | `公告列表.md` | +| [`stock_reports`](#api-stock-reports) | 研报列表 | `GET` | `api/v1/market/data/report/stock-reports` | `stock_code`, `start_date`, `end_date`, `type`, `page`, `page_size` | `研报列表.md` | +| [`type_reports`](#api-type-reports) | 研报分类 | `GET` | `api/v1/market/data/report/type-reports` | `rept_type`, `start_date`, `end_date`, `page`, `page_size` | `研报分类.md` | + +### 现货数据 + +| SDK 方法 | 接口名称 | HTTP | Path | 参数 | 来源文档 | +|---|---|---|---|---|---| +| [`bullion_price`](#api-bullion-price) | 贵金属价格 | `GET` | `api/v1/market/data/bullion/price` | `symbol`, `start_date`, `end_date`, `page`, `page_size` | `贵金属价格.md` | +| [`bullion_support_symbol`](#api-bullion-support-symbol) | 贵金属支持标的 | `GET` | `api/v1/market/data/bullion/support-symbol` | - | `贵金属支持标的.md` | + +### 外汇数据 + +| SDK 方法 | 接口名称 | HTTP | Path | 参数 | 来源文档 | +|---|---|---|---|---|---| +| [`consumer_forex_gold_monthly`](#api-consumer-forex-gold-monthly) | 外汇黄金 | `GET` | `api/v1/market/data/economic/china-forex-gold` | - | `外汇黄金.md` | + +### 未发布 + +| SDK 方法 | 接口名称 | HTTP | Path | 参数 | 来源文档 | +|---|---|---|---|---|---| +| [`stock_dividends_paginated`](#api-stock-dividends-paginated) | 股票分红记录分页 | `GET` | `api/v1/market/data/dividends` | `page`, `page_size` | `股票分红记录分页.md` | +| [`stock_intraday`](#api-stock-intraday) | 股票日内分时 | `GET` | `api/v1/market/security/{symbol}/intraday` | `symbol` | `股票日内分时.md` | +| [`stock_ipos_paginated`](#api-stock-ipos-paginated) | 股票IPO分页 | `GET` | `api/v1/market/data/stock-ipos` | `page`, `page_size` | `股票IPO分页.md` | +| [`stock_related`](#api-stock-related) | 相关股票 | `GET` | `api/v1/market/security/{symbol}/related` | `symbol`, `limit` | `相关股票.md` | ## 接口详情 -## 财务数据 +### 股票数据 -

baidu_financial_calendar

+

abnormal_trading_details

-- 接口名称：百度财经日历 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/finance/financial-calendar/baidu` -- 参数：`start_date`, `end_date`, `category`, `page`, `page_size` -- 原始接口：`baidu_financial_calendar` -- 来源文档：`百度财经日历.md` +- 接口名称：龙虎榜明细 +- HTTP：`GET` +- Path：`api/v1/market/data/abnormal-trading-details` +- 参数：`date` +- 来源文档：`龙虎榜明细.md` +- 原始接口：`abnormal_trading_details` + +```text +龙虎榜明细. + +Endpoint: ``api/v1/market/data/abnormal-trading-details``. +Method: ``GET``. +Documented endpoint: ``abnormal_trading_details``. + +Args: + date: 查询日期 YYYYMMDD；不传则使用当前内存快照 (type: string; required: N). + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + +Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. +``` + +

abnormal_trading_overview

-
-方法文档注释 +- 接口名称：龙虎榜总览 +- HTTP：`GET` +- Path：`api/v1/market/data/abnormal-trading-overview` +- 参数：`date` +- 来源文档：`龙虎榜总览.md` +- 原始接口：`abnormal_trading_overview` ```text -百度财经日历. +龙虎榜总览. -Endpoint: ``api/v1/market/data/finance/financial-calendar/baidu``. +Endpoint: ``api/v1/market/data/abnormal-trading-overview``. Method: ``GET``. -Documented endpoint: ``baidu_financial_calendar``. +Documented endpoint: ``abnormal_trading_overview``. Args: - start_date: 起始日期 (type: string; required: Y). - end_date: 结束日期（与 start_date 间隔 ≤ 3 天） (type: string; required: Y). - category: 筛选大类：`economic` / `ipo` / `report_time` / `trade_reminder`；不传返回全部 (type: string; required: N). + date: 查询日期 YYYYMMDD；不传则使用当前内存快照 (type: string; required: N). + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + +Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. +``` + +

auction_results

+ +- 接口名称：集合竞价结果 +- HTTP：`GET` +- Path：`api/v1/market/data/auction-results` +- 参数：`ts_code`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` +- 来源文档：`集合竞价结果.md` +- 原始接口：`auction_results` + +```text +集合竞价结果. + +Endpoint: ``api/v1/market/data/auction-results``. +Method: ``GET``. +Documented endpoint: ``auction_results``. + +Args: + ts_code: 股票代码，如 000001.XSHE (type: string; required: N). + trade_date: 交易日，格式 YYYYMMDD (type: string; required: N). + start_date: 起始日期，格式 YYYYMMDD (type: string; required: N). + end_date: 结束日期，格式 YYYYMMDD (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -314,20 +387,14 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

balance

+

balance

- 接口名称：A股资产负债表 -- 状态：可调用 -- HTTP 方法：`GET` +- HTTP：`GET` - Path：`api/v1/market/data/finance/balance` - 参数：`stock_code`, `year`, `report_type`, `page`, `page_size` -- 原始接口：`balance` - 来源文档：`A股资产负债表.md` - -
-方法文档注释 +- 原始接口：`balance` ```text A股资产负债表. @@ -356,20 +423,73 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

block_trades

+ +- 接口名称：大宗交易 +- HTTP：`GET` +- Path：`api/v1/market/data/block-trades` +- 参数：`date` +- 来源文档：`大宗交易.md` +- 原始接口：`block_trades` + +```text +大宗交易. + +Endpoint: ``api/v1/market/data/block-trades``. +Method: ``GET``. +Documented endpoint: ``block_trades``. + +Args: + date: 查询日期 YYYYMMDD；不传则使用当前内存快照 (type: string; required: N). + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + +Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. +``` + +

bse_mapping

+ +- 接口名称：北交所映射 +- HTTP：`GET` +- Path：`api/v1/market/data/bse-mapping` +- 参数：`o_code`, `n_code` +- 来源文档：`北交所映射.md` +- 原始接口：`get_bse_mapping` + +```text +北交所映射. + +Endpoint: ``api/v1/market/data/bse-mapping``. +Method: ``GET``. +Documented endpoint: ``get_bse_mapping``. + +Args: + o_code: 旧代码（如 `838163.BJ`） (type: string; required: N). + n_code: 新代码（如 `920163.BJ`） (type: string; required: N). + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + +Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. +``` -

cashflow

+

cashflow

- 接口名称：A股现金流量表 -- 状态：可调用 -- HTTP 方法：`GET` +- HTTP：`GET` - Path：`api/v1/market/data/finance/cashflow` - 参数：`stock_code`, `year`, `report_type`, `page`, `page_size` -- 原始接口：`cashflow` - 来源文档：`A股现金流量表.md` - -
-方法文档注释 +- 原始接口：`cashflow` ```text A股现金流量表. @@ -398,20 +518,14 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

cashflow_stock_code

+

cashflow_stock_code

- 接口名称：现金流支持股票代码 -- 状态：可调用 -- HTTP 方法：`GET` +- HTTP：`GET` - Path：`api/v1/market/data/finance/cashflow-stock-code` - 参数：- -- 原始接口：`get_cashflow_stock_code` - 来源文档：`现金流支持股票代码.md` - -
-方法文档注释 +- 原始接口：`get_cashflow_stock_code` ```text 现金流支持股票代码. @@ -432,20 +546,49 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

company_list

+ +- 接口名称：公司列表 +- HTTP：`GET` +- Path：`api/v1/market/data/company-list` +- 参数：`stock_name`, `stock_code`, `page`, `page_size` +- 来源文档：`公司列表.md` +- 原始接口：`get_company_list` + +```text +公司列表. + +Endpoint: ``api/v1/market/data/company-list``. +Method: ``GET``. +Documented endpoint: ``get_company_list``. + +Args: + stock_name: 股票名称，精确匹配 (type: string; required: N). + stock_code: 股票代码，精确匹配 (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + +Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. +``` -

earnings_reports_paginated

+

earnings_reports_paginated

- 接口名称：业绩快报 -- 状态：可调用 -- HTTP 方法：`GET` +- HTTP：`GET` - Path：`api/v1/market/data/finance/stock-performance-express` - 参数：`stock_code`, `year`, `report_type`, `page`, `page_size` -- 原始接口：`earnings_reports_paginated` - 来源文档：`业绩快报.md` - -
-方法文档注释 +- 原始接口：`earnings_reports_paginated` ```text 业绩快报. @@ -474,37 +617,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

income

- -- 接口名称：A股利润表 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/finance/income` -- 参数：`stock_code`, `year`, `report_type`, `page`, `page_size` -- 原始接口：`income` -- 来源文档：`A股利润表.md` +

eastmoney_board_constituents

-
-方法文档注释 +- 接口名称：东方财富板块成份股 +- HTTP：`GET` +- Path：`api/v1/market/data/eastmoney-board-constituents` +- 参数：`board_code` +- 来源文档：`东方财富板块成份股.md` +- 原始接口：`eastmoney_board_constituents` ```text -A股利润表. +东方财富板块成份股. -Endpoint: ``api/v1/market/data/finance/income``. +Endpoint: ``api/v1/market/data/eastmoney-board-constituents``. Method: ``GET``. -Documented endpoint: ``income``. +Documented endpoint: ``eastmoney_board_constituents``. Args: - stock_code: A 股代码，6 位数字 + 后缀（如 000001.SZ）；存在则进入模式A 单票查询 (type: string; required: N). - year: 年份（模式B 必填），如 2024 (type: int; required: N). - report_type: 报告期类型（模式B 必填）：q1 / q2 / q3 / annual（兼容 h1） (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. + board_code: 板块代码，如 BK1024 (type: string; required: Y). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -516,32 +646,26 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

performance_forecasts_paginated

- -- 接口名称：业绩预告 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/finance/stock-performance-forecast` -- 参数：`stock_code`, `year`, `report_type`, `page`, `page_size` -- 原始接口：`performance_forecasts_paginated` -- 来源文档：`业绩预告.md` +

eastmoney_board_daily_kline

-
-方法文档注释 +- 接口名称：东方财富板块日线OHLC +- HTTP：`GET` +- Path：`api/v1/market/data/eastmoney-board-daily-ohlc` +- 参数：`board_code`, `start_date`, `end_date`, `page`, `page_size` +- 来源文档：`东方财富板块日线OHLC.md` +- 原始接口：`eastmoney_board_daily_kline` ```text -业绩预告. +东方财富板块日线OHLC. -Endpoint: ``api/v1/market/data/finance/stock-performance-forecast``. +Endpoint: ``api/v1/market/data/eastmoney-board-daily-ohlc``. Method: ``GET``. -Documented endpoint: ``performance_forecasts_paginated``. +Documented endpoint: ``eastmoney_board_daily_kline``. Args: - stock_code: A 股代码，6 位数字 + 后缀（如 000001.SZ）；存在则进入模式A 单票查询 (type: string; required: N). - year: 年份（模式B 必填），如 2024 (type: int; required: N). - report_type: 报告期类型（模式B 必填）：q1 / q2 / q3 / annual (type: string; required: N). + board_code: 板块代码，如 BK1024 (type: string; required: Y). + start_date: 起始日期（含），YYYY-MM-DD 或 YYYYMMDD (type: string; required: N). + end_date: 截止日期（含），YYYY-MM-DD 或 YYYYMMDD (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -558,31 +682,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

wallstreetcn_financial_calendar

- -- 接口名称：华尔街见闻财经日历 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/finance/financial-calendar/wallstreetcn` -- 参数：`start_date`, `end_date`, `page`, `page_size` -- 原始接口：`wallstreetcn_financial_calendar` -- 来源文档：`华尔街见闻财经日历.md` +

eastmoney_board_latest_kline

-
-方法文档注释 +- 接口名称：东方财富板块最新OHLC +- HTTP：`GET` +- Path：`api/v1/market/data/eastmoney-board-latest-ohlc` +- 参数：`board_code`, `page`, `page_size` +- 来源文档：`东方财富板块最新OHLC.md` +- 原始接口：`eastmoney_board_latest_kline` ```text -华尔街见闻财经日历. +东方财富板块最新OHLC. -Endpoint: ``api/v1/market/data/finance/financial-calendar/wallstreetcn``. +Endpoint: ``api/v1/market/data/eastmoney-board-latest-ohlc``. Method: ``GET``. -Documented endpoint: ``wallstreetcn_financial_calendar``. +Documented endpoint: ``eastmoney_board_latest_kline``. Args: - start_date: 起始日期 (type: string; required: Y). - end_date: 结束日期（与 start_date 间隔 ≤ 3 天） (type: string; required: Y). + board_code: 板块代码，如 BK1024；不传则返回全部板块最新K线 (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -599,29 +716,21 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

eastmoney_concept_boards

-## 宏观经济 +- 接口名称：东方财富概念板块 +- HTTP：`GET` +- Path：`api/v1/market/data/eastmoney-concept-boards` +- 参数：- +- 来源文档：`东方财富概念板块.md` +- 原始接口：`eastmoney_concept_boards` -

consumer_credit_monthly

+```text +东方财富概念板块. -- 接口名称：社融信贷 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/economic/china-credit-loans` -- 参数：- -- 原始接口：`consumer_credit_monthly` -- 来源文档：`社融信贷.md` - -
-方法文档注释 - -```text -社融信贷. - -Endpoint: ``api/v1/market/data/economic/china-credit-loans``. +Endpoint: ``api/v1/market/data/eastmoney-concept-boards``. Method: ``GET``. -Documented endpoint: ``consumer_credit_monthly``. +Documented endpoint: ``eastmoney_concept_boards``. Args: raw: Return the decoded JSON payload without tabular extraction. @@ -635,29 +744,31 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

consumer_customs_trade_monthly

- -- 接口名称：进出口 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/economic/china-customs-trade` -- 参数：- -- 原始接口：`consumer_customs_trade_monthly` -- 来源文档：`进出口.md` +

eastmoney_dapan_flow

-
-方法文档注释 +- 接口名称：东方财富大盘资金流 +- HTTP：`GET` +- Path：`api/v1/market/data/eastmoney-dapan-flow` +- 参数：`trade_date`, `start_date`, `end_date`, `page`, `page_size` +- 来源文档：`东方财富大盘资金流.md` +- 原始接口：`get_eastmoney_dapan_flow` ```text -进出口. +东方财富大盘资金流. -Endpoint: ``api/v1/market/data/economic/china-customs-trade``. +Endpoint: ``api/v1/market/data/eastmoney-dapan-flow``. Method: ``GET``. -Documented endpoint: ``consumer_customs_trade_monthly``. +Documented endpoint: ``get_eastmoney_dapan_flow``. Args: + trade_date: 交易日 YYYYMMDD；与 start_date/end_date 互斥 (type: string; required: N). + start_date: 区间起始日 YYYYMMDD；需与 end_date 同时提供 (type: string; required: N). + end_date: 区间结束日 YYYYMMDD；需与 start_date 同时提供 (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -669,29 +780,32 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

eastmoney_market_valuation

-

consumer_fiscal_revenue_monthly

- -- 接口名称：财政收入 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/economic/china-fiscal-revenue` -- 参数：- -- 原始接口：`consumer_fiscal_revenue_monthly` -- 来源文档：`财政收入.md` - -
-方法文档注释 +- 接口名称：东方财富市场估值 +- HTTP：`GET` +- Path：`api/v1/market/data/eastmoney-market-valuation` +- 参数：`market_code`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` +- 来源文档：`东方财富市场估值.md` +- 原始接口：`get_eastmoney_market_valuation` ```text -财政收入. +东方财富市场估值. -Endpoint: ``api/v1/market/data/economic/china-fiscal-revenue``. +Endpoint: ``api/v1/market/data/eastmoney-market-valuation``. Method: ``GET``. -Documented endpoint: ``consumer_fiscal_revenue_monthly``. +Documented endpoint: ``get_eastmoney_market_valuation``. Args: + market_code: 市场代码，如 000001=上证指数、000300=沪深300；不传返回全部 (type: string; required: N). + trade_date: 交易日 YYYYMMDD；与 start_date/end_date 互斥 (type: string; required: N). + start_date: 区间起始日 YYYYMMDD；需与 end_date 同时提供 (type: string; required: N). + end_date: 区间结束日 YYYYMMDD；需与 start_date 同时提供 (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -703,29 +817,26 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

consumer_fixed_asset_monthly

- -- 接口名称：固定资产投资 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/economic/china-fixed-asset-investment` -- 参数：- -- 原始接口：`consumer_fixed_asset_monthly` -- 来源文档：`固定资产投资.md` +

eastmoney_rank

-
-方法文档注释 +- 接口名称：东方财富股票排名 +- HTTP：`GET` +- Path：`api/v1/market/data/eastmoney-rank` +- 参数：`rank_group`, `market`, `trade_date` +- 来源文档：`东方财富股票排名.md` +- 原始接口：`eastmoney_rank` ```text -固定资产投资. +东方财富股票排名. -Endpoint: ``api/v1/market/data/economic/china-fixed-asset-investment``. +Endpoint: ``api/v1/market/data/eastmoney-rank``. Method: ``GET``. -Documented endpoint: ``consumer_fixed_asset_monthly``. +Documented endpoint: ``eastmoney_rank``. Args: + rank_group: 榜单组：`hot`（人气榜）/ `up`（飙升榜） (type: string; required: N). + market: 市场：`A`（A股）/ `HK`（港股）/ `US`（美股） (type: string; required: N). + trade_date: 交易日期，格式 `YYYY-MM-DD`，不传默认取最新 (type: string; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -737,29 +848,33 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

eastmoney_sector_flow

-

consumer_forex_gold_monthly

- -- 接口名称：外汇黄金 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/economic/china-forex-gold` -- 参数：- -- 原始接口：`consumer_forex_gold_monthly` -- 来源文档：`外汇黄金.md` - -
-方法文档注释 +- 接口名称：东方财富板块资金流 +- HTTP：`GET` +- Path：`api/v1/market/data/eastmoney-sector-flow` +- 参数：`sector_code`, `sector_type`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` +- 来源文档：`东方财富板块资金流.md` +- 原始接口：`get_eastmoney_sector_flow` ```text -外汇黄金. +东方财富板块资金流. -Endpoint: ``api/v1/market/data/economic/china-forex-gold``. +Endpoint: ``api/v1/market/data/eastmoney-sector-flow``. Method: ``GET``. -Documented endpoint: ``consumer_forex_gold_monthly``. +Documented endpoint: ``get_eastmoney_sector_flow``. Args: + sector_code: 板块代码，如 BK0488 (type: string; required: N). + sector_type: 板块类型：industry / concept / regional (type: string; required: N). + trade_date: 交易日 YYYYMMDD；与 start_date/end_date 互斥 (type: string; required: N). + start_date: 区间起始日 YYYYMMDD；需与 end_date 同时提供 (type: string; required: N). + end_date: 区间结束日 YYYYMMDD；需与 start_date 同时提供 (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -771,29 +886,32 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

consumer_gdp_quarterly

- -- 接口名称：GDP -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/economic/china-gdp` -- 参数：- -- 原始接口：`consumer_gdp_quarterly` -- 来源文档：`GDP.md` +

eastmoney_stock_flow

-
-方法文档注释 +- 接口名称：东方财富个股资金流 +- HTTP：`GET` +- Path：`api/v1/market/data/eastmoney-stock-flow` +- 参数：`symbol`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` +- 来源文档：`东方财富个股资金流.md` +- 原始接口：`get_eastmoney_stock_flow` ```text -GDP. +东方财富个股资金流. -Endpoint: ``api/v1/market/data/economic/china-gdp``. +Endpoint: ``api/v1/market/data/eastmoney-stock-flow``. Method: ``GET``. -Documented endpoint: ``consumer_gdp_quarterly``. +Documented endpoint: ``get_eastmoney_stock_flow``. Args: + symbol: 股票代码，如 600522 (type: string; required: N). + trade_date: 交易日 YYYYMMDD；与 start_date/end_date 互斥 (type: string; required: N). + start_date: 区间起始日 YYYYMMDD；需与 end_date 同时提供 (type: string; required: N). + end_date: 区间结束日 YYYYMMDD；需与 start_date 同时提供 (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -805,29 +923,32 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

consumer_industrial_added_value_monthly

+

eastmoney_stock_valuation

-- 接口名称：工业增加值 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/economic/china-industrial-added-value` -- 参数：- -- 原始接口：`consumer_industrial_added_value_monthly` -- 来源文档：`工业增加值.md` - -
-方法文档注释 +- 接口名称：东方财富个股估值 +- HTTP：`GET` +- Path：`api/v1/market/data/eastmoney-stock-valuation` +- 参数：`symbol`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` +- 来源文档：`东方财富个股估值.md` +- 原始接口：`get_eastmoney_stock_valuation` ```text -工业增加值. +东方财富个股估值. -Endpoint: ``api/v1/market/data/economic/china-industrial-added-value``. +Endpoint: ``api/v1/market/data/eastmoney-stock-valuation``. Method: ``GET``. -Documented endpoint: ``consumer_industrial_added_value_monthly``. +Documented endpoint: ``get_eastmoney_stock_valuation``. Args: + symbol: 股票代码，如 000001；不传返回全部 (type: string; required: N). + trade_date: 交易日 YYYYMMDD；与 start_date/end_date 互斥 (type: string; required: N). + start_date: 区间起始日 YYYYMMDD；需与 end_date 同时提供 (type: string; required: N). + end_date: 区间结束日 YYYYMMDD；需与 start_date 同时提供 (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -839,29 +960,29 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

consumer_money_supply_monthly

- -- 接口名称：货币供应 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/economic/china-money-supply` -- 参数：- -- 原始接口：`consumer_money_supply_monthly` -- 来源文档：`货币供应.md` +

goodwill_industry

-
-方法文档注释 +- 接口名称：商誉行业 +- HTTP：`GET` +- Path：`api/v1/market/data/goodwill/industry` +- 参数：`date`, `page`, `page_size` +- 来源文档：`商誉行业.md` +- 原始接口：`goodwill_industry` ```text -货币供应. +商誉行业. -Endpoint: ``api/v1/market/data/economic/china-money-supply``. +Endpoint: ``api/v1/market/data/goodwill/industry``. Method: ``GET``. -Documented endpoint: ``consumer_money_supply_monthly``. +Documented endpoint: ``goodwill_industry``. Args: + date: 报告期，如 20250331 (type: string; required: Y). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -873,27 +994,21 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

goodwill_market_overview

-

consumer_pmi_monthly

- -- 接口名称：PMI -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/economic/china-pmi` +- 接口名称：商誉市场总览 +- HTTP：`GET` +- Path：`api/v1/market/data/goodwill/market-overview` - 参数：- -- 原始接口：`consumer_pmi_monthly` -- 来源文档：`PMI.md` - -
-方法文档注释 +- 来源文档：`商誉市场总览.md` +- 原始接口：`goodwill_market_overview` ```text -PMI. +商誉市场总览. -Endpoint: ``api/v1/market/data/economic/china-pmi``. +Endpoint: ``api/v1/market/data/goodwill/market-overview``. Method: ``GET``. -Documented endpoint: ``consumer_pmi_monthly``. +Documented endpoint: ``goodwill_market_overview``. Args: raw: Return the decoded JSON payload without tabular extraction. @@ -907,29 +1022,29 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

consumer_ppi_monthly

- -- 接口名称：PPI -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/economic/china-ppi` -- 参数：- -- 原始接口：`consumer_ppi_monthly` -- 来源文档：`PPI.md` +

goodwill_predict

-
-方法文档注释 +- 接口名称：商誉预测 +- HTTP：`GET` +- Path：`api/v1/market/data/goodwill/predict` +- 参数：`date`, `page`, `page_size` +- 来源文档：`商誉预测.md` +- 原始接口：`goodwill_predict` ```text -PPI. +商誉预测. -Endpoint: ``api/v1/market/data/economic/china-ppi``. +Endpoint: ``api/v1/market/data/goodwill/predict``. Method: ``GET``. -Documented endpoint: ``consumer_ppi_monthly``. +Documented endpoint: ``goodwill_predict``. Args: + date: 报告期，如 20250331 (type: string; required: Y). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -941,63 +1056,29 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

consumer_price_index_monthly

- -- 接口名称：CPI -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/economic/china-cpi` -- 参数：- -- 原始接口：`consumer_price_index_monthly` -- 来源文档：`CPI.md` +

goodwill_stock_detail

-
-方法文档注释 +- 接口名称：商誉个股明细 +- HTTP：`GET` +- Path：`api/v1/market/data/goodwill/stock-detail` +- 参数：`date`, `page`, `page_size` +- 来源文档：`商誉个股明细.md` +- 原始接口：`goodwill_stock_detail` ```text -CPI. +商誉个股明细. -Endpoint: ``api/v1/market/data/economic/china-cpi``. +Endpoint: ``api/v1/market/data/goodwill/stock-detail``. Method: ``GET``. -Documented endpoint: ``consumer_price_index_monthly``. - -Args: - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - -Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. -``` - -
- -

consumer_retail_sales_monthly

- -- 接口名称：社零 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/economic/china-retail-sales` -- 参数：- -- 原始接口：`consumer_retail_sales_monthly` -- 来源文档：`社零.md` - -
-方法文档注释 - -```text -社零. - -Endpoint: ``api/v1/market/data/economic/china-retail-sales``. -Method: ``GET``. -Documented endpoint: ``consumer_retail_sales_monthly``. +Documented endpoint: ``goodwill_stock_detail``. Args: + date: 报告期，如 20250331 (type: string; required: Y). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -1009,29 +1090,29 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

lpr_monthly

- -- 接口名称：LPR -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/economic/china-lpr` -- 参数：- -- 原始接口：`lpr_monthly` -- 来源文档：`LPR.md` +

goodwill_stock_impairment

-
-方法文档注释 +- 接口名称：商誉减值 +- HTTP：`GET` +- Path：`api/v1/market/data/goodwill/stock-impairment` +- 参数：`date`, `page`, `page_size` +- 来源文档：`商誉减值.md` +- 原始接口：`goodwill_stock_impairment` ```text -LPR. +商誉减值. -Endpoint: ``api/v1/market/data/economic/china-lpr``. +Endpoint: ``api/v1/market/data/goodwill/stock-impairment``. Method: ``GET``. -Documented endpoint: ``lpr_monthly``. +Documented endpoint: ``goodwill_stock_impairment``. Args: + date: 报告期，如 20250331 (type: string; required: Y). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -1043,27 +1124,21 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

hk_sh_stock_connect_members

-

reserve_ratio_monthly

- -- 接口名称：存款准备金率 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/economic/china-reserve-ratio` +- 接口名称：沪港通成份 +- HTTP：`GET` +- Path：`api/v1/market/data/hk-sh-stock-connect-members` - 参数：- -- 原始接口：`reserve_ratio_monthly` -- 来源文档：`存款准备金率.md` - -
-方法文档注释 +- 来源文档：`沪港通成份.md` +- 原始接口：`hk_sh_stock_connect_members` ```text -存款准备金率. +沪港通成份. -Endpoint: ``api/v1/market/data/economic/china-reserve-ratio``. +Endpoint: ``api/v1/market/data/hk-sh-stock-connect-members``. Method: ``GET``. -Documented endpoint: ``reserve_ratio_monthly``. +Documented endpoint: ``hk_sh_stock_connect_members``. Args: raw: Return the decoded JSON payload without tabular extraction. @@ -1077,136 +1152,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

hk_sz_stock_connect_members

-

tax_revenue_monthly

- -- 接口名称：税收 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/economic/china-tax-revenue` +- 接口名称：深港通成份 +- HTTP：`GET` +- Path：`api/v1/market/data/hk-sz-stock-connect-members` - 参数：- -- 原始接口：`tax_revenue_monthly` -- 来源文档：`税收.md` - -
-方法文档注释 - -```text -税收. - -Endpoint: ``api/v1/market/data/economic/china-tax-revenue``. -Method: ``GET``. -Documented endpoint: ``tax_revenue_monthly``. - -Args: - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - -Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. -``` - -
- -

us_economic

- -- 接口名称：美国经济指标 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/economic/us-economic` -- 参数：`type` -- 原始接口：`us_economic` -- 来源文档：`美国经济指标.md` - -
-方法文档注释 - -```text -美国经济指标. - -Endpoint: ``api/v1/market/data/economic/us-economic``. -Method: ``GET``. -Documented endpoint: ``us_economic``. - -Args: - type: 指标类型，枚举值见下表 (type: string; required: Y). - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - -Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. -``` - -
- -## 股票 - -

abnormal_trading_details

- -- 接口名称：龙虎榜明细 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/abnormal-trading-details` -- 参数：`date` -- 原始接口：`abnormal_trading_details` -- 来源文档：`龙虎榜明细.md` - -
-方法文档注释 - -```text -龙虎榜明细. - -Endpoint: ``api/v1/market/data/abnormal-trading-details``. -Method: ``GET``. -Documented endpoint: ``abnormal_trading_details``. - -Args: - date: 查询日期 YYYYMMDD；不传则使用当前内存快照 (type: string; required: N). - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - -Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. -``` - -
- -

abnormal_trading_overview

- -- 接口名称：龙虎榜总览 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/abnormal-trading-overview` -- 参数：`date` -- 原始接口：`abnormal_trading_overview` -- 来源文档：`龙虎榜总览.md` - -
-方法文档注释 +- 来源文档：`深港通成份.md` +- 原始接口：`hk_sz_stock_connect_members` ```text -龙虎榜总览. +深港通成份. -Endpoint: ``api/v1/market/data/abnormal-trading-overview``. +Endpoint: ``api/v1/market/data/hk-sz-stock-connect-members``. Method: ``GET``. -Documented endpoint: ``abnormal_trading_overview``. +Documented endpoint: ``hk_sz_stock_connect_members``. Args: - date: 查询日期 YYYYMMDD；不传则使用当前内存快照 (type: string; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -1218,33 +1180,26 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

auction_results

- -- 接口名称：集合竞价结果 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/auction-results` -- 参数：`ts_code`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` -- 原始接口：`auction_results` -- 来源文档：`集合竞价结果.md` +

income

-
-方法文档注释 +- 接口名称：A股利润表 +- HTTP：`GET` +- Path：`api/v1/market/data/finance/income` +- 参数：`stock_code`, `year`, `report_type`, `page`, `page_size` +- 来源文档：`A股利润表.md` +- 原始接口：`income` ```text -集合竞价结果. +A股利润表. -Endpoint: ``api/v1/market/data/auction-results``. +Endpoint: ``api/v1/market/data/finance/income``. Method: ``GET``. -Documented endpoint: ``auction_results``. +Documented endpoint: ``income``. Args: - ts_code: 股票代码，如 000001.XSHE (type: string; required: N). - trade_date: 交易日，格式 YYYYMMDD (type: string; required: N). - start_date: 起始日期，格式 YYYYMMDD (type: string; required: N). - end_date: 结束日期，格式 YYYYMMDD (type: string; required: N). + stock_code: A 股代码，6 位数字 + 后缀（如 000001.SZ）；存在则进入模式A 单票查询 (type: string; required: N). + year: 年份（模式B 必填），如 2024 (type: int; required: N). + report_type: 报告期类型（模式B 必填）：q1 / q2 / q3 / annual（兼容 h1） (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -1261,55 +1216,14 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

block_trades

- -- 接口名称：大宗交易 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/block-trades` -- 参数：`date` -- 原始接口：`block_trades` -- 来源文档：`大宗交易.md` - -
-方法文档注释 - -```text -大宗交易. - -Endpoint: ``api/v1/market/data/block-trades``. -Method: ``GET``. -Documented endpoint: ``block_trades``. - -Args: - date: 查询日期 YYYYMMDD；不传则使用当前内存快照 (type: string; required: N). - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - -Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. -``` - -
- -

limit_down_pool

+

limit_down_pool

- 接口名称：跌停池 -- 状态：可调用 -- HTTP 方法：`GET` +- HTTP：`GET` - Path：`api/v1/market/data/limit-down-pool` - 参数：- -- 原始接口：`limit_down_pool` - 来源文档：`跌停池.md` - -
-方法文档注释 +- 原始接口：`limit_down_pool` ```text 跌停池. @@ -1330,20 +1244,14 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

limit_event_timeline_3s

+

limit_event_timeline_3s

- 接口名称：涨跌停事件时间线 -- 状态：可调用 -- HTTP 方法：`GET` +- HTTP：`GET` - Path：`api/v1/market/data/limit-event-timeline-3s` - 参数：`symbol` -- 原始接口：`limit_event_timeline_3s` - 来源文档：`涨跌停事件时间线.md` - -
-方法文档注释 +- 原始接口：`limit_event_timeline_3s` ```text 涨跌停事件时间线. @@ -1365,20 +1273,14 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

limit_up_break_pool

+

limit_up_break_pool

- 接口名称：炸板池 -- 状态：可调用 -- HTTP 方法：`GET` +- HTTP：`GET` - Path：`api/v1/market/data/limit-up-break-pool` - 参数：- -- 原始接口：`limit_up_break_pool` - 来源文档：`炸板池.md` - -
-方法文档注释 +- 原始接口：`limit_up_break_pool` ```text 炸板池. @@ -1399,20 +1301,14 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

limit_up_pool

+

limit_up_pool

- 接口名称：涨停池 -- 状态：可调用 -- HTTP 方法：`GET` +- HTTP：`GET` - Path：`api/v1/market/data/limit-up-pool` - 参数：- -- 原始接口：`limit_up_pool` - 来源文档：`涨停池.md` - -
-方法文档注释 +- 原始接口：`limit_up_pool` ```text 涨停池. @@ -1433,20 +1329,14 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

limit_up_pool_yesterday

+

limit_up_pool_yesterday

- 接口名称：昨日涨停池 -- 状态：可调用 -- HTTP 方法：`GET` +- HTTP：`GET` - Path：`api/v1/market/data/limit-up-pool-yesterday` - 参数：- -- 原始接口：`limit_up_pool_yesterday` - 来源文档：`昨日涨停池.md` - -
-方法文档注释 +- 原始接口：`limit_up_pool_yesterday` ```text 昨日涨停池. @@ -1467,20 +1357,14 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

margin_trading_details

+

margin_trading_details

- 接口名称：融资融券明细 -- 状态：可调用 -- HTTP 方法：`GET` +- HTTP：`GET` - Path：`api/v1/market/data/margin-trading-details` - 参数：`date`, `page`, `page_size` -- 原始接口：`margin_trading_details` - 来源文档：`融资融券明细.md` - -
-方法文档注释 +- 原始接口：`margin_trading_details` ```text 融资融券明细. @@ -1507,20 +1391,14 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

margin_trading_details_paginated

+

margin_trading_details_paginated

- 接口名称：融资融券明细分页 -- 状态：可调用 -- HTTP 方法：`GET` +- HTTP：`GET` - Path：`api/v1/market/data/margin-trading-details` - 参数：`date`, `page`, `page_size` -- 原始接口：`margin_trading_details_paginated` - 来源文档：`融资融券明细分页.md` - -
-方法文档注释 +- 原始接口：`margin_trading_details_paginated` ```text 融资融券明细分页. @@ -1547,27 +1425,21 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

northbound

-

risk_warning_stock_quotes

- -- 接口名称：风险警示股行情 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/risk-warning-stocks/quotes` +- 接口名称：北向资金交易 +- HTTP：`GET` +- Path：`api/v1/market/data/northbound` - 参数：`date` -- 原始接口：`risk_warning_stock_quotes` -- 来源文档：`风险警示股行情.md` - -
-方法文档注释 +- 来源文档：`北向资金交易.md` +- 原始接口：`northbound` ```text -风险警示股行情. +北向资金交易. -Endpoint: ``api/v1/market/data/risk-warning-stocks/quotes``. +Endpoint: ``api/v1/market/data/northbound``. Method: ``GET``. -Documented endpoint: ``risk_warning_stock_quotes``. +Documented endpoint: ``northbound``. Args: date: 交易日，格式 YYYYMMDD (type: string; required: Y). @@ -1582,30 +1454,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

nth_trade_date

-

risk_warning_stocks

- -- 接口名称：风险警示股 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/risk-warning-stocks` -- 参数：`date` -- 原始接口：`risk_warning_stocks` -- 来源文档：`风险警示股.md` - -
-方法文档注释 +- 接口名称：第N个交易日 +- HTTP：`GET` +- Path：`api/v1/market/data/time/get-nth-trade-date` +- 参数：`n` +- 来源文档：`第N个交易日.md` +- 原始接口：`get_nth_trade_date` ```text -风险警示股. +第N个交易日. -Endpoint: ``api/v1/market/data/risk-warning-stocks``. +Endpoint: ``api/v1/market/data/time/get-nth-trade-date``. Method: ``GET``. -Documented endpoint: ``risk_warning_stocks``. +Documented endpoint: ``get_nth_trade_date``. Args: - date: 交易日，格式 YYYYMMDD (type: string; required: Y). + n: 需要获取的前 N 个交易日，N >= 1 (type: uint32; required: Y). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -1617,36 +1483,26 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stk_limit

- -- 接口名称：涨跌停价 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/stk-limit` -- 参数：`instrument_type`, `symbol`, `symbol_id`, `market_id`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` -- 原始接口：`stk_limit` -- 来源文档：`涨跌停价.md` +

performance_forecasts_paginated

-
-方法文档注释 +- 接口名称：业绩预告 +- HTTP：`GET` +- Path：`api/v1/market/data/finance/stock-performance-forecast` +- 参数：`stock_code`, `year`, `report_type`, `page`, `page_size` +- 来源文档：`业绩预告.md` +- 原始接口：`performance_forecasts_paginated` ```text -涨跌停价. +业绩预告. -Endpoint: ``api/v1/market/data/stk-limit``. +Endpoint: ``api/v1/market/data/finance/stock-performance-forecast``. Method: ``GET``. -Documented endpoint: ``stk_limit``. +Documented endpoint: ``performance_forecasts_paginated``. Args: - instrument_type: 标的类型：stock / etf / cb；不传返回三类（排除指数） (type: string; required: N). - symbol: 标的代码，支持 000001.SZ / 000001.XSHE / 600519.SH 等；存在时忽略 symbol_id+market_id (type: string; required: N). - symbol_id: 标的 ID，与 market_id 配合使用 (type: int32; required: N). - market_id: 市场 ID，与 symbol_id 配合使用 (type: int16; required: N). - trade_date: 交易日 YYYYMMDD，查单日全市场时使用 (type: int32; required: N). - start_date: 单票历史区间起始日 YYYYMMDD（需配 symbol 或 symbol_id+market_id） (type: int32; required: N). - end_date: 单票历史区间结束日 YYYYMMDD (type: int32; required: N). + stock_code: A 股代码，6 位数字 + 后缀（如 000001.SZ）；存在则进入模式A 单票查询 (type: string; required: N). + year: 年份（模式B 必填），如 2024 (type: int; required: N). + report_type: 报告期类型（模式B 必填）：q1 / q2 / q3 / annual (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -1663,38 +1519,27 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

price_change

-

stk_premarket

- -- 接口名称：盘前数据 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/stk-premarket` -- 参数：`ts_code`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` -- 原始接口：`stk_premarket` -- 来源文档：`盘前数据.md` - -
-方法文档注释 +- 接口名称：价格变动 +- HTTP：`GET` +- Path：`api/v1/market/data/price/get-price-change` +- 参数：`stock_code`, `base_date`, `n`, `direction` +- 来源文档：`价格变动.md` +- 原始接口：`get_price_change` ```text -盘前数据. +价格变动. -Endpoint: ``api/v1/market/data/stk-premarket``. +Endpoint: ``api/v1/market/data/price/get-price-change``. Method: ``GET``. -Documented endpoint: ``stk_premarket``. +Documented endpoint: ``get_price_change``. Args: - ts_code: 股票代码，如 000001.SZ / 600519.SH (type: string; required: N). - trade_date: 交易日 YYYYMMDD，查单日全市场时使用 (type: int32; required: N). - start_date: 单票历史区间起始日 YYYYMMDD（需配 ts_code） (type: int32; required: N). - end_date: 单票历史区间结束日 YYYYMMDD (type: int32; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. + stock_code: 目标股票 6 位纯数字代码，兼容沪市/深市/创业板/科创板 (type: string; required: Y). + base_date: 涨跌幅计算基准日，格式 YYYYMMDD (type: string; required: Y). + n: 需计算的有效交易日数量，建议不超过 365 (type: uint32; required: Y). + direction: 计算方向：forward（基准日为结束日）/ backward（基准日为开始日） (type: string; required: Y). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -1706,35 +1551,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_adjust_factor

+

risk_warning_stock_quotes

-- 接口名称：股票复权因子 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/stock-adjust-factor` -- 参数：`symbol`, `trade_date`, `start_date`, `end_date`, `offset`, `limit` -- 原始接口：`stock_adjust_factor` -- 来源文档：`股票复权因子.md` - -
-方法文档注释 +- 接口名称：风险警示股行情 +- HTTP：`GET` +- Path：`api/v1/market/data/risk-warning-stocks/quotes` +- 参数：`date` +- 来源文档：`风险警示股行情.md` +- 原始接口：`risk_warning_stock_quotes` ```text -股票复权因子. +风险警示股行情. -Endpoint: ``api/v1/market/data/stock-adjust-factor``. +Endpoint: ``api/v1/market/data/risk-warning-stocks/quotes``. Method: ``GET``. -Documented endpoint: ``stock_adjust_factor``. +Documented endpoint: ``risk_warning_stock_quotes``. Args: - symbol: 股票代码，支持纯数字或带后缀格式；区间扫描必填 (type: string; required: N). - trade_date: 交易日期 YYYYMMDD；空则默认当天，非交易日回退前一交易日 (type: string; required: N). - start_date: 区间起始日期 YYYYMMDD；区间扫描必填且需配 symbol (type: string; required: N). - end_date: 区间结束日期 YYYYMMDD；区间扫描必填且需配 symbol (type: string; required: N). - offset: 返回结果起始偏移 (type: int; required: N). - limit: 返回结果最大条数 (type: int; required: N). + date: 交易日，格式 YYYYMMDD (type: string; required: Y). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -1746,38 +1580,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

risk_warning_stocks

-

stock_announcements

- -- 接口名称：公告列表 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/announcements/stock-announcements` -- 参数：`stock_code`, `start_date`, `end_date`, `type`, `page`, `page_size` -- 原始接口：`stock_announcements` -- 来源文档：`公告列表.md` - -
-方法文档注释 +- 接口名称：风险警示股 +- HTTP：`GET` +- Path：`api/v1/market/data/risk-warning-stocks` +- 参数：`date` +- 来源文档：`风险警示股.md` +- 原始接口：`risk_warning_stocks` ```text -公告列表. +风险警示股. -Endpoint: ``api/v1/market/data/announcements/stock-announcements``. +Endpoint: ``api/v1/market/data/risk-warning-stocks``. Method: ``GET``. -Documented endpoint: ``stock_announcements``. +Documented endpoint: ``risk_warning_stocks``. Args: - stock_code: 证券代码（按标的查询时必填） (type: string; required: N). - start_date: 开始日期 YYYYMMDD（按日期范围查询时必填） (type: string; required: N). - end_date: 结束日期 YYYYMMDD，不填默认当前时间 (type: string; required: N). - type: 查询类型，当前只支持 `stock` (type: string; required: Y). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. + date: 交易日，格式 YYYYMMDD (type: string; required: Y). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -1789,36 +1609,25 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_candlesticks

- -- 接口名称：股票K线 -- 状态：可调用 -- HTTP 方法：`POST` -- Path：`api/v1/market/data/stock-candlesticks` -- 参数：`symbol`, `interval_unit`, `interval_value`, `adjust_kind`, `since_ts_millis`, `until_ts_millis`, `limit` -- 原始接口：`stock_candlesticks` -- 来源文档：`股票K线.md` + -
-方法文档注释 +- 接口名称：标的搜索 +- HTTP：`GET` +- Path：`api/v1/market/security/search` +- 参数：`query`, `limit` +- 来源文档：`标的搜索.md` +- 原始接口：`search` ```text -股票K线. +标的搜索. -Endpoint: ``api/v1/market/data/stock-candlesticks``. -Method: ``POST``. -Documented endpoint: ``stock_candlesticks``. +Endpoint: ``api/v1/market/security/search``. +Method: ``GET``. +Documented endpoint: ``search``. Args: - symbol: 标的代码，如 000001.SZ (type: SymbolKey; required: Y). - interval_unit: 周期单位：Minute/Day/Week/Month/Year (type: enum; required: Y). - interval_value: 间隔数值（默认1，如 Day+1=日K，Minute+5=5分钟） (type: int; required: N). - adjust_kind: 复权：None(默认,除权)/Forward(前复权)/Backward(后复权) (type: enum; required: N). - since_ts_millis: 开始时间戳（毫秒）；与 until 跨度 ≤3 天 (type: DateTime(ms); required: N). - until_ts_millis: 结束时间戳（毫秒） (type: DateTime(ms); required: Y). - limit: 返回条数上限 (type: int; required: N). + query: 搜索关键词；支持名称、标的代码、拼音全拼/首字母；大小写不敏感，自动 trim (type: string; required: Y). + limit: 返回最大条数，默认 1 (type: int; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -1830,36 +1639,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_candlesticks_batch

- -- 接口名称：批量股票K线 -- 状态：可调用 -- HTTP 方法：`POST` -- Path：`api/v1/market/data/stock-candlesticks/batch` -- 参数：`symbols`, `interval_unit`, `interval_value`, `adjust_kind`, `since_ts_millis`, `until_ts_millis`, `limit` -- 原始接口：`stock_candlesticks_batch` -- 来源文档：`批量股票K线.md` +

sh_hk_stock_connect_members

-
-方法文档注释 +- 接口名称：沪股通成份 +- HTTP：`GET` +- Path：`api/v1/market/data/sh-hk-stock-connect-members` +- 参数：- +- 来源文档：`沪股通成份.md` +- 原始接口：`sh_hk_stock_connect_members` ```text -批量股票K线. +沪股通成份. -Endpoint: ``api/v1/market/data/stock-candlesticks/batch``. -Method: ``POST``. -Documented endpoint: ``stock_candlesticks_batch``. +Endpoint: ``api/v1/market/data/sh-hk-stock-connect-members``. +Method: ``GET``. +Documented endpoint: ``sh_hk_stock_connect_members``. Args: - symbols: 标的代码列表，如 ["000001.SZ","600000.SH"] (type: array[SymbolKey]; required: Y). - interval_unit: 周期单位：Minute/Day/Week/Month/Year (type: enum; required: Y). - interval_value: 间隔数值（默认1） (type: int; required: N). - adjust_kind: 复权：None(默认)/Forward(前复权)/Backward(后复权) (type: enum; required: N). - since_ts_millis: 开始时间戳（毫秒）；与 until 跨度 ≤3 天 (type: DateTime(ms); required: N). - until_ts_millis: 结束时间戳（毫秒） (type: DateTime(ms); required: Y). - limit: 每标的返回条数上限 (type: int; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -1871,35 +1667,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_capital_flows

- -- 接口名称：股票资金流向 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/stock-capital-flows` -- 参数：`date`, `page`, `page_size` -- 原始接口：`stock_capital_flows_paginated` -- 来源文档：`股票资金流向.md` +

southbound

-
-方法文档注释 +- 接口名称：南向资金交易 +- HTTP：`GET` +- Path：`api/v1/market/data/southbound` +- 参数：`date` +- 来源文档：`南向资金交易.md` +- 原始接口：`southbound` ```text -股票资金流向. +南向资金交易. -Endpoint: ``api/v1/market/data/stock-capital-flows``. +Endpoint: ``api/v1/market/data/southbound``. Method: ``GET``. -Documented endpoint: ``stock_capital_flows_paginated``. +Documented endpoint: ``southbound``. Args: - date: 查询日期 YYYYMMDD；传入时查询该日 15:30 快照 (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. + date: 交易日，格式 YYYYMMDD (type: string; required: Y). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -1911,30 +1696,28 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_capital_flows_paginated

- -- 接口名称：股票资金流向 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/stock-capital-flows` -- 参数：`date`, `page`, `page_size` -- 原始接口：`stock_capital_flows_paginated` -- 来源文档：`股票资金流向.md` +

stk_ah_comparison

-
-方法文档注释 +- 接口名称：AH股对比 +- HTTP：`GET` +- Path：`api/v1/market/data/hk/stk-ah-comparison` +- 参数：`hk_code`, `ts_code`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` +- 来源文档：`AH股对比.md` +- 原始接口：`get_stk_ah_comparison` ```text -股票资金流向. +AH股对比. -Endpoint: ``api/v1/market/data/stock-capital-flows``. +Endpoint: ``api/v1/market/data/hk/stk-ah-comparison``. Method: ``GET``. -Documented endpoint: ``stock_capital_flows_paginated``. +Documented endpoint: ``get_stk_ah_comparison``. Args: - date: 查询日期 YYYYMMDD；传入时查询该日 15:30 快照 (type: string; required: N). + hk_code: 港股股票代码，支持 `700` 或 `00700.HK` (type: string; required: N). + ts_code: A 股股票代码，格式 `xxxxxx.SH/SZ/BJ` (type: string; required: N). + trade_date: 交易日期 YYYYMMDD (type: int32; required: N). + start_date: 起始日期 YYYYMMDD (type: int32; required: N). + end_date: 结束日期 YYYYMMDD (type: int32; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -1951,30 +1734,35 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_comment_desire_em

+

stk_limit

-- 接口名称：千股千评意愿度 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/stock-comment/desire` -- 参数：`symbol` -- 原始接口：`stock_comment_desire_em` -- 来源文档：`千股千评意愿度.md` - -
-方法文档注释 +- 接口名称：涨跌停价 +- HTTP：`GET` +- Path：`api/v1/market/data/stk-limit` +- 参数：`instrument_type`, `symbol`, `symbol_id`, `market_id`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` +- 来源文档：`涨跌停价.md` +- 原始接口：`stk_limit` ```text -千股千评意愿度. +涨跌停价. -Endpoint: ``api/v1/market/data/stock-comment/desire``. +Endpoint: ``api/v1/market/data/stk-limit``. Method: ``GET``. -Documented endpoint: ``stock_comment_desire_em``. +Documented endpoint: ``stk_limit``. Args: - symbol: 证券代码（纯数字，如 600000） (type: string; required: Y). + instrument_type: 标的类型：stock / etf / cb；不传返回三类（排除指数） (type: string; required: N). + symbol: 标的代码，支持 000001.SZ / 000001.XSHE / 600519.SH 等；存在时忽略 symbol_id+market_id (type: string; required: N). + symbol_id: 标的 ID，与 market_id 配合使用 (type: int32; required: N). + market_id: 市场 ID，与 symbol_id 配合使用 (type: int16; required: N). + trade_date: 交易日 YYYYMMDD，查单日全市场时使用 (type: int32; required: N). + start_date: 单票历史区间起始日 YYYYMMDD（需配 symbol 或 symbol_id+market_id） (type: int32; required: N). + end_date: 单票历史区间结束日 YYYYMMDD (type: int32; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -1986,29 +1774,27 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_comment_em

- -- 接口名称：千股千评 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/stock-comment/index` -- 参数：`page`, `page_size` -- 原始接口：`stock_comment_em` -- 来源文档：`千股千评.md` +

stk_premarket

-
-方法文档注释 +- 接口名称：盘前数据 +- HTTP：`GET` +- Path：`api/v1/market/data/stk-premarket` +- 参数：`ts_code`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` +- 来源文档：`盘前数据.md` +- 原始接口：`stk_premarket` ```text -千股千评. +盘前数据. -Endpoint: ``api/v1/market/data/stock-comment/index``. +Endpoint: ``api/v1/market/data/stk-premarket``. Method: ``GET``. -Documented endpoint: ``stock_comment_em``. +Documented endpoint: ``stk_premarket``. Args: + ts_code: 股票代码，如 000001.SZ / 600519.SH (type: string; required: N). + trade_date: 交易日 YYYYMMDD，查单日全市场时使用 (type: int32; required: N). + start_date: 单票历史区间起始日 YYYYMMDD（需配 ts_code） (type: int32; required: N). + end_date: 单票历史区间结束日 YYYYMMDD (type: int32; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -2025,30 +1811,29 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_comment_focus_em

- -- 接口名称：千股千评关注度 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/stock-comment/focus` -- 参数：`symbol` -- 原始接口：`stock_comment_focus_em` -- 来源文档：`千股千评关注度.md` +

stock_adjust_factor

-
-方法文档注释 +- 接口名称：股票复权因子 +- HTTP：`GET` +- Path：`api/v1/market/data/stock-adjust-factor` +- 参数：`symbol`, `trade_date`, `start_date`, `end_date`, `offset`, `limit` +- 来源文档：`股票复权因子.md` +- 原始接口：`stock_adjust_factor` ```text -千股千评关注度. +股票复权因子. -Endpoint: ``api/v1/market/data/stock-comment/focus``. +Endpoint: ``api/v1/market/data/stock-adjust-factor``. Method: ``GET``. -Documented endpoint: ``stock_comment_focus_em``. +Documented endpoint: ``stock_adjust_factor``. Args: - symbol: 证券代码（纯数字，如 600000） (type: string; required: Y). + symbol: 股票代码，支持纯数字或带后缀格式；区间扫描必填 (type: string; required: N). + trade_date: 交易日期 YYYYMMDD；空则默认当天，非交易日回退前一交易日 (type: string; required: N). + start_date: 区间起始日期 YYYYMMDD；区间扫描必填且需配 symbol (type: string; required: N). + end_date: 区间结束日期 YYYYMMDD；区间扫描必填且需配 symbol (type: string; required: N). + offset: 返回结果起始偏移 (type: int; required: N). + limit: 返回结果最大条数 (type: int; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -2060,30 +1845,30 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_comment_org_participate_em

- -- 接口名称：机构参与度 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/stock-comment/org-participate` -- 参数：`symbol` -- 原始接口：`stock_comment_org_participate_em` -- 来源文档：`机构参与度.md` +

stock_candlesticks

-
-方法文档注释 +- 接口名称：股票K线 +- HTTP：`POST` +- Path：`api/v1/market/data/stock-candlesticks` +- 参数：`symbol`, `interval_unit`, `interval_value`, `adjust_kind`, `since_ts_millis`, `until_ts_millis`, `limit` +- 来源文档：`股票K线.md` +- 原始接口：`stock_candlesticks` ```text -机构参与度. +股票K线. -Endpoint: ``api/v1/market/data/stock-comment/org-participate``. -Method: ``GET``. -Documented endpoint: ``stock_comment_org_participate_em``. +Endpoint: ``api/v1/market/data/stock-candlesticks``. +Method: ``POST``. +Documented endpoint: ``stock_candlesticks``. Args: - symbol: 证券代码（纯数字，如 600000） (type: string; required: Y). + symbol: 标的代码，如 000001.SZ (type: SymbolKey; required: Y). + interval_unit: 周期单位：Minute/Day/Week/Month/Year (type: enum; required: Y). + interval_value: 间隔数值（默认1，如 Day+1=日K，Minute+5=5分钟） (type: int; required: N). + adjust_kind: 复权：None(默认,除权)/Forward(前复权)/Backward(后复权) (type: enum; required: N). + since_ts_millis: 开始时间戳（毫秒）；与 until 跨度 ≤3 天 (type: DateTime(ms); required: N). + until_ts_millis: 结束时间戳（毫秒） (type: DateTime(ms); required: Y). + limit: 返回条数上限 (type: int; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -2095,30 +1880,30 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_comment_score_em

+

stock_candlesticks_batch

-- 接口名称：千股千评评分 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/stock-comment/score` -- 参数：`symbol` -- 原始接口：`stock_comment_score_em` -- 来源文档：`千股千评评分.md` - -
-方法文档注释 +- 接口名称：批量股票K线 +- HTTP：`POST` +- Path：`api/v1/market/data/stock-candlesticks/batch` +- 参数：`symbols`, `interval_unit`, `interval_value`, `adjust_kind`, `since_ts_millis`, `until_ts_millis`, `limit` +- 来源文档：`批量股票K线.md` +- 原始接口：`stock_candlesticks_batch` ```text -千股千评评分. +批量股票K线. -Endpoint: ``api/v1/market/data/stock-comment/score``. -Method: ``GET``. -Documented endpoint: ``stock_comment_score_em``. +Endpoint: ``api/v1/market/data/stock-candlesticks/batch``. +Method: ``POST``. +Documented endpoint: ``stock_candlesticks_batch``. Args: - symbol: 证券代码（纯数字，如 600000） (type: string; required: Y). + symbols: 标的代码列表，如 ["000001.SZ","600000.SH"] (type: array[SymbolKey]; required: Y). + interval_unit: 周期单位：Minute/Day/Week/Month/Year (type: enum; required: Y). + interval_value: 间隔数值（默认1） (type: int; required: N). + adjust_kind: 复权：None(默认)/Forward(前复权)/Backward(后复权) (type: enum; required: N). + since_ts_millis: 开始时间戳（毫秒）；与 until 跨度 ≤3 天 (type: DateTime(ms); required: N). + until_ts_millis: 结束时间戳（毫秒） (type: DateTime(ms); required: Y). + limit: 每标的返回条数上限 (type: int; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -2130,29 +1915,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_dividends_paginated

- -- 接口名称：股票分红记录分页 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/dividends` -- 参数：`page`, `page_size` -- 原始接口：`stock_dividends_paginated` -- 来源文档：`股票分红记录分页.md` +

stock_capital_flows_paginated

-
-方法文档注释 +- 接口名称：股票资金流向 +- HTTP：`GET` +- Path：`api/v1/market/data/stock-capital-flows` +- 参数：`date`, `page`, `page_size` +- 来源文档：`股票资金流向.md` +- 原始接口：`stock_capital_flows_paginated` ```text -股票分红记录分页. +股票资金流向. -Endpoint: ``api/v1/market/data/dividends``. +Endpoint: ``api/v1/market/data/stock-capital-flows``. Method: ``GET``. -Documented endpoint: ``stock_dividends_paginated``. +Documented endpoint: ``stock_capital_flows_paginated``. Args: + date: 查询日期 YYYYMMDD；传入时查询该日 15:30 快照 (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -2169,36 +1949,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_filter

- -- 接口名称：股票筛选 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/stock-list/filter` -- 参数：`board`, `listing_date_since`, `page`, `page_size` -- 原始接口：`stock_filter` -- 来源文档：`股票筛选.md` +

stock_comment_desire_em

-
-方法文档注释 +- 接口名称：千股千评意愿度 +- HTTP：`GET` +- Path：`api/v1/market/data/stock-comment/desire` +- 参数：`symbol` +- 来源文档：`千股千评意愿度.md` +- 原始接口：`stock_comment_desire_em` ```text -股票筛选. +千股千评意愿度. -Endpoint: ``api/v1/market/data/stock-list/filter``. +Endpoint: ``api/v1/market/data/stock-comment/desire``. Method: ``GET``. -Documented endpoint: ``stock_filter``. +Documented endpoint: ``stock_comment_desire_em``. Args: - board: 板块/交易所筛选：`star` / `chi_next` / `bjse` / `xshg` / `xshe` / `main` (type: string; required: N). - listing_date_since: 上市日期起点 YYYYMMDD，筛选此后上市的股票 (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. + symbol: 证券代码（纯数字，如 600000） (type: string; required: Y). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -2210,32 +1978,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

stock_comment_em

-

stock_institution_holdings

- -- 接口名称：机构持股 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/share/stock-institution-holdings` -- 参数：`year`, `report_type`, `inst_type`, `page`, `page_size` -- 原始接口：`get_stock_institution_holdings` -- 来源文档：`机构持股.md` - -
-方法文档注释 +- 接口名称：千股千评 +- HTTP：`GET` +- Path：`api/v1/market/data/stock-comment/index` +- 参数：`page`, `page_size` +- 来源文档：`千股千评.md` +- 原始接口：`stock_comment_em` ```text -机构持股. +千股千评. -Endpoint: ``api/v1/market/data/share/stock-institution-holdings``. +Endpoint: ``api/v1/market/data/stock-comment/index``. Method: ``GET``. -Documented endpoint: ``get_stock_institution_holdings``. +Documented endpoint: ``stock_comment_em``. Args: - year: 年份 (type: int; required: Y). - report_type: 报告类型：q1 / q2 / q3 / annual / announcement (type: ReportType; required: Y). - inst_type: 机构类型：all_inst / fund / qfii / insurance / social_security / securities / trust / other (type: InstitutionType; required: Y). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -2252,38 +2011,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_institution_holdings_detail

- -- 接口名称：机构持股明细 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/share/stock-institution-holdings-detail` -- 参数：`stock_code`, `year`, `report_type`, `inst_type`, `page`, `page_size` -- 原始接口：`get_stock_institution_holdings_detail` -- 来源文档：`机构持股明细.md` +

stock_comment_focus_em

-
-方法文档注释 +- 接口名称：千股千评关注度 +- HTTP：`GET` +- Path：`api/v1/market/data/stock-comment/focus` +- 参数：`symbol` +- 来源文档：`千股千评关注度.md` +- 原始接口：`stock_comment_focus_em` ```text -机构持股明细. +千股千评关注度. -Endpoint: ``api/v1/market/data/share/stock-institution-holdings-detail``. +Endpoint: ``api/v1/market/data/stock-comment/focus``. Method: ``GET``. -Documented endpoint: ``get_stock_institution_holdings_detail``. +Documented endpoint: ``stock_comment_focus_em``. Args: - stock_code: 股票代码 (type: string; required: Y). - year: 年份 (type: int; required: Y). - report_type: 报告类型：q1 / q2 / q3 / annual / announcement (type: ReportType; required: Y). - inst_type: 机构类型：all_inst / fund / qfii / insurance / social_security / securities / trust / other (type: InstitutionType; required: Y). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. + symbol: 证券代码（纯数字，如 600000） (type: string; required: Y). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -2295,33 +2040,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_institution_share_holdings

- -- 接口名称：机构股本持股 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/institution/institution-share-holdings` -- 参数：`institution_id`, `year`, `report_type`, `invest_type` -- 原始接口：`get_stock_institution_share_holdings` -- 来源文档：`机构股本持股.md` +

stock_comment_org_participate_em

-
-方法文档注释 +- 接口名称：机构参与度 +- HTTP：`GET` +- Path：`api/v1/market/data/stock-comment/org-participate` +- 参数：`symbol` +- 来源文档：`机构参与度.md` +- 原始接口：`stock_comment_org_participate_em` ```text -机构股本持股. +机构参与度. -Endpoint: ``api/v1/market/data/institution/institution-share-holdings``. +Endpoint: ``api/v1/market/data/stock-comment/org-participate``. Method: ``GET``. -Documented endpoint: ``get_stock_institution_share_holdings``. +Documented endpoint: ``stock_comment_org_participate_em``. Args: - institution_id: 机构 ID (type: string; required: Y). - year: 年份 (type: int; required: Y). - report_type: 报告类型：q1 / q2 / q3 / annual / announcement (type: ReportType; required: Y). - invest_type: 持仓类型：all / stock / fund / bond / other (type: InvestType; required: Y). + symbol: 证券代码（纯数字，如 600000） (type: string; required: Y). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -2333,30 +2069,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

stock_comment_score_em

-

stock_intraday

- -- 接口名称：股票日内分时 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/security/{symbol}/intraday` +- 接口名称：千股千评评分 +- HTTP：`GET` +- Path：`api/v1/market/data/stock-comment/score` - 参数：`symbol` -- 原始接口：`stock_intraday` -- 来源文档：`股票日内分时.md` - -
-方法文档注释 +- 来源文档：`千股千评评分.md` +- 原始接口：`stock_comment_score_em` ```text -股票日内分时. +千股千评评分. -Endpoint: ``api/v1/market/security/{symbol}/intraday``. +Endpoint: ``api/v1/market/data/stock-comment/score``. Method: ``GET``. -Documented endpoint: ``stock_intraday``. +Documented endpoint: ``stock_comment_score_em``. Args: - symbol: 标的代码 (type: SymbolKey; required: Y). + symbol: 证券代码（纯数字，如 600000） (type: string; required: Y). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -2368,30 +2098,25 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_intraday_auction_volume

- -- 接口名称：集合竞价成交量 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/intraday-auction-volume` -- 参数：`trade_date`, `page`, `page_size` -- 原始接口：`stock_intraday_auction_volume` -- 来源文档：`集合竞价成交量.md` +

stock_filter

-
-方法文档注释 +- 接口名称：股票筛选 +- HTTP：`GET` +- Path：`api/v1/market/data/stock-list/filter` +- 参数：`board`, `listing_date_since`, `page`, `page_size` +- 来源文档：`股票筛选.md` +- 原始接口：`stock_filter` ```text -集合竞价成交量. +股票筛选. -Endpoint: ``api/v1/market/data/intraday-auction-volume``. +Endpoint: ``api/v1/market/data/stock-list/filter``. Method: ``GET``. -Documented endpoint: ``stock_intraday_auction_volume``. +Documented endpoint: ``stock_filter``. Args: - trade_date: 交易日期 YYYYMMDD；不传返回当日实时数据 (type: string; required: N). + board: 板块/交易所筛选：`star` / `chi_next` / `bjse` / `xshg` / `xshe` / `main` (type: string; required: N). + listing_date_since: 上市日期起点 YYYYMMDD，筛选此后上市的股票 (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -2408,31 +2133,25 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_intraday_auction_volume_symbol

+

stock_float_holders

-- 接口名称：单标的集合竞价成交量 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/intraday-auction-volume/symbol` -- 参数：`symbol`, `trade_date`, `page`, `page_size` -- 原始接口：`stock_intraday_auction_volume_symbol` -- 来源文档：`单标的集合竞价成交量.md` - -
-方法文档注释 +- 接口名称：十大流通股东 +- HTTP：`GET` +- Path：`api/v1/market/data/holder/stock-holder-ften` +- 参数：`stock_code`, `is_last`, `page`, `page_size` +- 来源文档：`十大流通股东.md` +- 原始接口：`stock_float_holders` ```text -单标的集合竞价成交量. +十大流通股东. -Endpoint: ``api/v1/market/data/intraday-auction-volume/symbol``. +Endpoint: ``api/v1/market/data/holder/stock-holder-ften``. Method: ``GET``. -Documented endpoint: ``stock_intraday_auction_volume_symbol``. +Documented endpoint: ``stock_float_holders``. Args: - symbol: 标的代码，格式 code.suffix（XSHG/SH、XSHE/SZ、BJSE/BJ） (type: string; required: Y). - trade_date: 交易日期 YYYYMMDD；不传返回当日实时数据 (type: string; required: N). + stock_code: 标的代码，指定时返回该标的全部历史数据 (type: string; required: N). + is_last: 是否取所有标的最新一期，true 时按 page/page_size 分页 (type: bool; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -2449,29 +2168,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_ipos

- -- 接口名称：股票IPO -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/stock-ipos` -- 参数：`page`, `page_size` -- 原始接口：`stock_ipos` -- 来源文档：`股票IPO.md` +

stock_ggcg_em

-
-方法文档注释 +- 接口名称：东方财富股东增减持 +- HTTP：`GET` +- Path：`api/v1/market/data/holder/stock-ggcg-em` +- 参数：`symbol`, `page`, `page_size` +- 来源文档：`东方财富股东增减持.md` +- 原始接口：`stock_ggcg_em_handler` ```text -股票IPO. +东方财富股东增减持. -Endpoint: ``api/v1/market/data/stock-ipos``. +Endpoint: ``api/v1/market/data/holder/stock-ggcg-em``. Method: ``GET``. -Documented endpoint: ``stock_ipos``. +Documented endpoint: ``stock_ggcg_em_handler``. Args: + symbol: 数据类型：全部 / 股东增持 / 股东减持，默认全部 (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -2488,29 +2202,27 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

stock_ggmx

-

stock_ipos_paginated

- -- 接口名称：股票IPO分页 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/stock-ipos` -- 参数：`page`, `page_size` -- 原始接口：`stock_ipos_paginated` -- 来源文档：`股票IPO分页.md` - -
-方法文档注释 +- 接口名称：董监高持股变动 +- HTTP：`GET` +- Path：`api/v1/market/data/holder/stock-ggmx` +- 参数：`stock_code`, `change_direction`, `start_date`, `end_date`, `page`, `page_size` +- 来源文档：`董监高持股变动.md` +- 原始接口：`stock_ggmx_handler` ```text -股票IPO分页. +董监高持股变动. -Endpoint: ``api/v1/market/data/stock-ipos``. +Endpoint: ``api/v1/market/data/holder/stock-ggmx``. Method: ``GET``. -Documented endpoint: ``stock_ipos_paginated``. +Documented endpoint: ``stock_ggmx_handler``. Args: + stock_code: 股票代码（如 600001），别名 stockCode (type: string; required: N). + change_direction: 变动方向：增持 / 减持，别名 changeDirection (type: string; required: N). + start_date: 变动日期起始 YYYY-MM-DD，别名 startDate (type: string; required: N). + end_date: 变动日期截止 YYYY-MM-DD，别名 endDate (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -2527,29 +2239,29 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_list

- -- 接口名称：股票列表 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/stock-list` -- 参数：- -- 原始接口：`get_stock_list` -- 来源文档：`股票列表.md` +

stock_ggmx_buy_ranking

-
-方法文档注释 +- 接口名称：董监高增持排名 +- HTTP：`GET` +- Path：`api/v1/market/data/holder/stock-ggmx-buy-ranking` +- 参数：`time_range`, `page`, `page_size` +- 来源文档：`董监高增持排名.md` +- 原始接口：`stock_ggmx_buy_ranking_handler` ```text -股票列表. +董监高增持排名. -Endpoint: ``api/v1/market/data/stock-list``. +Endpoint: ``api/v1/market/data/holder/stock-ggmx-buy-ranking``. Method: ``GET``. -Documented endpoint: ``get_stock_list``. +Documented endpoint: ``stock_ggmx_buy_ranking_handler``. Args: + time_range: 时间范围：1m / 3m / 6m / 1y / 2y，默认 1m，别名 timeRange (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -2561,30 +2273,29 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_market

- -- 接口名称：股票市场行情 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/daec/market/snapshot` -- 参数：`scope` -- 原始接口：`stock_market` -- 来源文档：`股票市场行情.md` +

stock_ggmx_sell_ranking

-
-方法文档注释 +- 接口名称：董监高减持排名 +- HTTP：`GET` +- Path：`api/v1/market/data/holder/stock-ggmx-sell-ranking` +- 参数：`time_range`, `page`, `page_size` +- 来源文档：`董监高减持排名.md` +- 原始接口：`stock_ggmx_sell_ranking_handler` ```text -股票市场行情. +董监高减持排名. -Endpoint: ``api/v1/market/data/daec/market/snapshot``. +Endpoint: ``api/v1/market/data/holder/stock-ggmx-sell-ranking``. Method: ``GET``. -Documented endpoint: ``stock_market``. +Documented endpoint: ``stock_ggmx_sell_ranking_handler``. Args: - scope: 市场范围：ChinaStock(默认) / Xshg / Xshe / Bjse (type: string; required: N). + time_range: 时间范围：1m / 3m / 6m / 1y / 2y，默认 1m，别名 timeRange (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -2596,30 +2307,30 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_market_distribution_intraday

- -- 接口名称：市场涨跌分布分时 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/daec/market/distribution-history` -- 参数：`scope` -- 原始接口：`stock_market_distribution_intraday` -- 来源文档：`市场涨跌分布分时.md` +

stock_holders

-
-方法文档注释 +- 接口名称：十大股东 +- HTTP：`GET` +- Path：`api/v1/market/data/holder/stock-holder-ten` +- 参数：`stock_code`, `is_last`, `page`, `page_size` +- 来源文档：`十大股东.md` +- 原始接口：`stock_holders` ```text -市场涨跌分布分时. +十大股东. -Endpoint: ``api/v1/market/data/daec/market/distribution-history``. +Endpoint: ``api/v1/market/data/holder/stock-holder-ten``. Method: ``GET``. -Documented endpoint: ``stock_market_distribution_intraday``. +Documented endpoint: ``stock_holders``. Args: - scope: 市场范围：ChinaStock(默认) / Xshg / Xshe / Bjse (type: string; required: N). + stock_code: 标的代码，指定时返回该标的全部历史数据 (type: string; required: N). + is_last: 是否取所有标的最新一期，true 时按 page/page_size 分页 (type: bool; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -2631,32 +2342,30 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_prev_close

- -- 接口名称：股票前收盘价 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/daec/history/prev-closes` -- 参数：`symbol`, `since`, `until` -- 原始接口：`stock_prev_close` -- 来源文档：`股票前收盘价.md` +

stock_holders_number

-
-方法文档注释 +- 接口名称：股东人数 +- HTTP：`GET` +- Path：`api/v1/market/data/holder/stock-holder-nums` +- 参数：`stock_code`, `is_last`, `page`, `page_size` +- 来源文档：`股东人数.md` +- 原始接口：`stock_holders_number` ```text -股票前收盘价. +股东人数. -Endpoint: ``api/v1/market/data/daec/history/prev-closes``. +Endpoint: ``api/v1/market/data/holder/stock-holder-nums``. Method: ``GET``. -Documented endpoint: ``stock_prev_close``. +Documented endpoint: ``stock_holders_number``. Args: - symbol: 标的代码 (type: SymbolKey; required: Y). - since: 开始日期，格式 YYYYMMDD (type: date; required: Y). - until: 结束日期，格式 YYYYMMDD (type: date; required: Y). + stock_code: 标的代码，指定时返回该标的全部历史数据 (type: string; required: N). + is_last: 是否取所有标的最新一期，true 时按 page/page_size 分页 (type: bool; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -2668,32 +2377,31 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_rating_top5

+

stock_institution_holdings

-- 接口名称：飞兔股票评级Top5 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/feitu/stock-rating-top5` -- 参数：`date`, `variant`, `type` -- 原始接口：`stock_rating_top5` -- 来源文档：`飞兔股票评级Top5.md` - -
-方法文档注释 +- 接口名称：机构持股 +- HTTP：`GET` +- Path：`api/v1/market/data/share/stock-institution-holdings` +- 参数：`year`, `report_type`, `inst_type`, `page`, `page_size` +- 来源文档：`机构持股.md` +- 原始接口：`get_stock_institution_holdings` ```text -飞兔股票评级Top5. +机构持股. -Endpoint: ``api/v1/market/data/feitu/stock-rating-top5``. +Endpoint: ``api/v1/market/data/share/stock-institution-holdings``. Method: ``GET``. -Documented endpoint: ``stock_rating_top5``. +Documented endpoint: ``get_stock_institution_holdings``. Args: - date: 日期 YYYYMMDD (type: string; required: Y). - variant: 档位，如 300001（30w01）、300000（30w），默认 300001 (type: string; required: N). - type: 市场：all / xshg / xshe / bjse，默认 all (type: StockRatingMarketFilter; required: N). + year: 年份 (type: int; required: Y). + report_type: 报告类型：q1 / q2 / q3 / annual / announcement (type: ReportType; required: Y). + inst_type: 机构类型：all_inst / fund / qfii / insurance / social_security / securities / trust / other (type: InstitutionType; required: Y). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -2705,31 +2413,32 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- - - -- 接口名称：相关股票 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/security/{symbol}/related` -- 参数：`symbol`, `limit` -- 原始接口：`stock_related` -- 来源文档：`相关股票.md` +

stock_institution_holdings_detail

-
-方法文档注释 +- 接口名称：机构持股明细 +- HTTP：`GET` +- Path：`api/v1/market/data/share/stock-institution-holdings-detail` +- 参数：`stock_code`, `year`, `report_type`, `inst_type`, `page`, `page_size` +- 来源文档：`机构持股明细.md` +- 原始接口：`get_stock_institution_holdings_detail` ```text -相关股票. +机构持股明细. -Endpoint: ``api/v1/market/security/{symbol}/related``. +Endpoint: ``api/v1/market/data/share/stock-institution-holdings-detail``. Method: ``GET``. -Documented endpoint: ``stock_related``. +Documented endpoint: ``get_stock_institution_holdings_detail``. Args: - symbol: 标的代码 (type: SymbolKey; required: Y). - limit: 返回数量上限，服务端默认 3 (type: int; required: N). + stock_code: 股票代码 (type: string; required: Y). + year: 年份 (type: int; required: Y). + report_type: 报告类型：q1 / q2 / q3 / annual / announcement (type: ReportType; required: Y). + inst_type: 机构类型：all_inst / fund / qfii / insurance / social_security / securities / trust / other (type: InstitutionType; required: Y). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -2741,33 +2450,56 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

stock_institution_share_holdings

-

stock_reports

+- 接口名称：机构股本持股 +- HTTP：`GET` +- Path：`api/v1/market/data/institution/institution-share-holdings` +- 参数：`institution_id`, `year`, `report_type`, `invest_type` +- 来源文档：`机构股本持股.md` +- 原始接口：`get_stock_institution_share_holdings` -- 接口名称：研报列表 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/report/stock-reports` -- 参数：`stock_code`, `start_date`, `end_date`, `type`, `page`, `page_size` -- 原始接口：`stock_reports` -- 来源文档：`研报列表.md` +```text +机构股本持股. + +Endpoint: ``api/v1/market/data/institution/institution-share-holdings``. +Method: ``GET``. +Documented endpoint: ``get_stock_institution_share_holdings``. + +Args: + institution_id: 机构 ID (type: string; required: Y). + year: 年份 (type: int; required: Y). + report_type: 报告类型：q1 / q2 / q3 / annual / announcement (type: ReportType; required: Y). + invest_type: 持仓类型：all / stock / fund / bond / other (type: InvestType; required: Y). + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + +Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. +``` + +

stock_intraday_auction_volume

-
-方法文档注释 +- 接口名称：集合竞价成交量 +- HTTP：`GET` +- Path：`api/v1/market/data/intraday-auction-volume` +- 参数：`trade_date`, `page`, `page_size` +- 来源文档：`集合竞价成交量.md` +- 原始接口：`stock_intraday_auction_volume` ```text -研报列表. +集合竞价成交量. -Endpoint: ``api/v1/market/data/report/stock-reports``. +Endpoint: ``api/v1/market/data/intraday-auction-volume``. Method: ``GET``. -Documented endpoint: ``stock_reports``. +Documented endpoint: ``stock_intraday_auction_volume``. Args: - stock_code: 证券代码（按标的查询时必填） (type: string; required: N). - start_date: 开始日期 YYYYMMDD（按日期范围查询时必填） (type: string; required: N). - end_date: 结束日期 YYYYMMDD，不填默认当前时间 (type: string; required: N). - type: 查询类型，当前只支持 `stock` (type: string; required: Y). + trade_date: 交易日期 YYYYMMDD；不传返回当日实时数据 (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -2784,31 +2516,30 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_share

- -- 接口名称：股本 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/share/get-stock-share` -- 参数：`stock_code`, `date` -- 原始接口：`get_stock_share_handler` -- 来源文档：`股本.md` +

stock_intraday_auction_volume_symbol

-
-方法文档注释 +- 接口名称：单标的集合竞价成交量 +- HTTP：`GET` +- Path：`api/v1/market/data/intraday-auction-volume/symbol` +- 参数：`symbol`, `trade_date`, `page`, `page_size` +- 来源文档：`单标的集合竞价成交量.md` +- 原始接口：`stock_intraday_auction_volume_symbol` ```text -股本. +单标的集合竞价成交量. -Endpoint: ``api/v1/market/data/share/get-stock-share``. +Endpoint: ``api/v1/market/data/intraday-auction-volume/symbol``. Method: ``GET``. -Documented endpoint: ``get_stock_share_handler``. +Documented endpoint: ``stock_intraday_auction_volume_symbol``. Args: - stock_code: 股票代码 (type: string; required: Y). - date: 日期 YYYYMMDD (type: string; required: Y). + symbol: 标的代码，格式 code.suffix（XSHG/SH、XSHE/SZ、BJSE/BJ） (type: string; required: Y). + trade_date: 交易日期 YYYYMMDD；不传返回当日实时数据 (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -2820,30 +2551,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_signal_latest_snapshot

- -- 接口名称：信号最新快照 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/stock-signal-latest-snapshot` -- 参数：`signal_type`, `page`, `page_size` -- 原始接口：`stock_signal_latest_snapshot` -- 来源文档：`信号最新快照.md` +

stock_ipos

-
-方法文档注释 +- 接口名称：股票IPO +- HTTP：`GET` +- Path：`api/v1/market/data/stock-ipos` +- 参数：`page`, `page_size` +- 来源文档：`股票IPO.md` +- 原始接口：`stock_ipos` ```text -信号最新快照. +股票IPO. -Endpoint: ``api/v1/market/data/stock-signal-latest-snapshot``. +Endpoint: ``api/v1/market/data/stock-ipos``. Method: ``GET``. -Documented endpoint: ``stock_signal_latest_snapshot``. +Documented endpoint: ``stock_ipos``. Args: - signal_type: 信号类型过滤，不传返回全部。可选值：`new_high_month`、`new_high_60d`、`new_high_120d`、`new_high_250d`、`new_low_month`、`new_low_60d`、`new_low_120d`、`new_low_250d`、`consecutive_up`、`consecutive_down`、`consecutive_vol_up`、`consecutive_vol_down`、`break_up_ma5`、`break_up_ma10`、`break_up_ma20`、`break_down_ma5`、`break_down_ma10`、`break_down_ma20`、`vol_price_rise`、`vol_price_fall` (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -2860,30 +2584,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

stock_list

-

stock_trade

- -- 接口名称：股票分时成交 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/daec/history/trades` -- 参数：`symbol` -- 原始接口：`stock_trade` -- 来源文档：`股票分时成交.md` - -
-方法文档注释 +- 接口名称：股票列表 +- HTTP：`GET` +- Path：`api/v1/market/data/stock-list` +- 参数：- +- 来源文档：`股票列表.md` +- 原始接口：`get_stock_list` ```text -股票分时成交. +股票列表. -Endpoint: ``api/v1/market/data/daec/history/trades``. +Endpoint: ``api/v1/market/data/stock-list``. Method: ``GET``. -Documented endpoint: ``stock_trade``. +Documented endpoint: ``get_stock_list``. Args: - symbol: 标的代码 (type: SymbolKey; required: Y). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -2895,35 +2612,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_unlock

- -- 接口名称：限售解禁 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/unlock/stock-unlock` -- 参数：`stock_code`, `page`, `page_size` -- 原始接口：`stock_unlock_handler` -- 来源文档：`限售解禁.md` +

stock_market

-
-方法文档注释 +- 接口名称：市场行情快照 +- HTTP：`GET` +- Path：`api/v1/market/data/daec/market/snapshot` +- 参数：`scope` +- 来源文档：`市场行情快照.md` +- 原始接口：`stock_market` ```text -限售解禁. +股票市场行情. -Endpoint: ``api/v1/market/data/unlock/stock-unlock``. +Endpoint: ``api/v1/market/data/daec/market/snapshot``. Method: ``GET``. -Documented endpoint: ``stock_unlock_handler``. +Documented endpoint: ``stock_market``. Args: - stock_code: 证券代码 (type: string; required: Y). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. + scope: 市场范围：ChinaStock(默认) / Xshg / Xshe / Bjse (type: string; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -2935,36 +2641,60 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

stock_market_distribution_intraday

-

stock_unlock_by_date

+- 接口名称：日内涨跌停分布历史 +- HTTP：`GET` +- Path：`api/v1/market/data/daec/market/distribution-history` +- 参数：`scope` +- 来源文档：`日内涨跌停分布历史.md` +- 原始接口：`stock_market_distribution_intraday` -- 接口名称：限售解禁按日期 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/unlock/stock-unlock-by-date` -- 参数：`start_date`, `end_date`, `page`, `page_size` -- 原始接口：`stock_unlock_by_date_handler` -- 来源文档：`限售解禁按日期.md` +```text +市场涨跌分布分时. + +Endpoint: ``api/v1/market/data/daec/market/distribution-history``. +Method: ``GET``. +Documented endpoint: ``stock_market_distribution_intraday``. + +Args: + scope: 市场范围：ChinaStock(默认) / Xshg / Xshe / Bjse (type: string; required: N). + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + +Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. +``` + +

stock_daec_stocks

-
-方法文档注释 +- 接口名称：A股行情列表 +- HTTP：`GET` +- Path：`api/v1/market/data/daec/stocks/{board}` +- 参数：`board`, `page`, `page_size`, `filter`, `order_by` +- 来源文档：`A股行情列表.md` +- 原始接口：`stock_daec_stocks` ```text -限售解禁按日期. +A股行情列表（DAEC 全字段族）. -Endpoint: ``api/v1/market/data/unlock/stock-unlock-by-date``. +Endpoint: ``api/v1/market/data/daec/stocks/{board}``. Method: ``GET``. -Documented endpoint: ``stock_unlock_by_date_handler``. +Documented endpoint: ``stock_daec_stocks``. Args: - start_date: 起始日期（YYYY-MM-DD） (type: string; required: Y). - end_date: 结束日期（YYYY-MM-DD） (type: string; required: Y). + board: 板块路径参数，如 all / xshg / xshe / bjse (type: string; required: Y). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. all_pages: Fetch and combine pages until the server reports the last page. max_pages: Optional safety cap for ``all_pages``. + filter: 筛选表达式，如 ``close > 10`` 或 ``name.contains("银行")`` (type: string; required: N). + order_by: 排序表达式，如 ``change_rate desc`` (type: string; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -2976,30 +2706,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

suspension_list

- -- 接口名称：停牌列表 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/suspension-list` -- 参数：`trade_date`, `page`, `page_size` -- 原始接口：`suspension_list` -- 来源文档：`停牌列表.md` +

stock_realtime_list

-
-方法文档注释 +- 接口名称：A股行情列表 +- HTTP：`GET` +- Path：`api/v1/market/data/stock-list/{board}` +- 参数：`board`, `page`, `page_size` +- 来源文档：`A股行情列表.md` +- 原始接口：`stock_realtime_list` ```text -停牌列表. +A股行情列表（stock-list 实时行情族）. -Endpoint: ``api/v1/market/data/suspension-list``. +Endpoint: ``api/v1/market/data/stock-list/{board}``. Method: ``GET``. -Documented endpoint: ``suspension_list``. +Documented endpoint: ``stock_realtime_list``. Args: - trade_date: 交易日，格式 YYYYMMDD，默认当天 (type: string; required: N). + board: 板块路径参数，如 chi-next / star / new (type: string; required: Y). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -3016,33 +2740,30 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -## 市场与其他 - -

bse_mapping

- -- 接口名称：北交所映射 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/bse-mapping` -- 参数：`o_code`, `n_code` -- 原始接口：`get_bse_mapping` -- 来源文档：`北交所映射.md` +

stock_pledge_detail

-
-方法文档注释 +- 接口名称：股权质押明细 +- HTTP：`GET` +- Path：`api/v1/market/data/pledge/pledge-detail` +- 参数：`stock_code`, `is_last`, `page`, `page_size` +- 来源文档：`股权质押明细.md` +- 原始接口：`stock_pledge_detail` ```text -北交所映射. +股权质押明细. -Endpoint: ``api/v1/market/data/bse-mapping``. +Endpoint: ``api/v1/market/data/pledge/pledge-detail``. Method: ``GET``. -Documented endpoint: ``get_bse_mapping``. +Documented endpoint: ``stock_pledge_detail``. Args: - o_code: 旧代码（如 `838163.BJ`） (type: string; required: N). - n_code: 新代码（如 `920163.BJ`） (type: string; required: N). + stock_code: 股票代码（symbol.suffix 格式或纯代码）；不传时需配合 `is_last=true` (type: string; required: N). + is_last: 是否仅获取最新一期（无 `stock_code` 时必填为 true） (type: bool; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -3054,32 +2775,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

stock_pledge_summary

-

bullion_price

- -- 接口名称：贵金属价格 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/bullion/price` -- 参数：`symbol`, `start_date`, `end_date`, `page`, `page_size` -- 原始接口：`get_bullion_price` -- 来源文档：`贵金属价格.md` - -
-方法文档注释 +- 接口名称：股权质押汇总 +- HTTP：`GET` +- Path：`api/v1/market/data/pledge/pledge-summary` +- 参数：`page`, `page_size` +- 来源文档：`股权质押汇总.md` +- 原始接口：`stock_pledge_summary` ```text -贵金属价格. +股权质押汇总. -Endpoint: ``api/v1/market/data/bullion/price``. +Endpoint: ``api/v1/market/data/pledge/pledge-summary``. Method: ``GET``. -Documented endpoint: ``get_bullion_price``. +Documented endpoint: ``stock_pledge_summary``. Args: - symbol: 标的代码，如 XAUUSD、AU9999 (type: string; required: Y). - start_date: 查询起始日期 YYYYMMDD (type: int; required: Y). - end_date: 查询结束日期 YYYYMMDD；与 start_date 跨度 ≤3 天 (type: int; required: Y). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -3096,29 +2808,26 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

bullion_support_symbol

- -- 接口名称：贵金属支持标的 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/bullion/support-symbol` -- 参数：- -- 原始接口：`get_bullion_support_symbol` -- 来源文档：`贵金属支持标的.md` +

stock_prev_close

-
-方法文档注释 +- 接口名称：标的昨收价 +- HTTP：`GET` +- Path：`api/v1/market/data/daec/history/prev-closes` +- 参数：`symbol`, `since`, `until` +- 来源文档：`标的昨收价.md` +- 原始接口：`stock_prev_close` ```text -贵金属支持标的. +股票前收盘价. -Endpoint: ``api/v1/market/data/bullion/support-symbol``. +Endpoint: ``api/v1/market/data/daec/history/prev-closes``. Method: ``GET``. -Documented endpoint: ``get_bullion_support_symbol``. +Documented endpoint: ``stock_prev_close``. Args: + symbol: 标的代码 (type: SymbolKey; required: Y). + since: 开始日期，格式 YYYYMMDD (type: date; required: Y). + until: 结束日期，格式 YYYYMMDD (type: date; required: Y). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -3130,30 +2839,27 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

stock_intraday_prices

-

cb_base_data

- -- 接口名称：可转债基础数据 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/cb/cb-base-data` -- 参数：`symbol_code` -- 原始接口：`get_cb_base_data_handler` -- 来源文档：`可转债基础数据.md` - -
-方法文档注释 +- 接口名称：标的分时数据 +- HTTP：`GET` +- Path：`api/v1/market/data/daec/history/prices` +- 参数：`symbol`, `range`, `days`, `ts_ms` +- 来源文档：`标得分时数据.md` +- 原始接口：`stock_intraday_prices` ```text -可转债基础数据. +标的分时数据. -Endpoint: ``api/v1/market/data/cb/cb-base-data``. +Endpoint: ``api/v1/market/data/daec/history/prices``. Method: ``GET``. -Documented endpoint: ``get_cb_base_data_handler``. +Documented endpoint: ``stock_intraday_prices``. Args: - symbol_code: 转债代码 (type: string; required: Y). + symbol: 标的代码，如 600000.XSHG (type: string; required: Y). + range: 预置时间区间：Today / FiveDays (type: string; required: N). + days: 近 N 个交易日至今 (type: uint32; required: N). + ts_ms: 起始毫秒时间戳 (type: int64; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -3165,70 +2871,26 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

stock_rating_top5

-

cb_lists

- -- 接口名称：可转债列表 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/cb/cb-lists` -- 参数：- -- 原始接口：`get_cb_lists_handler` -- 来源文档：`可转债列表.md` - -
-方法文档注释 - -```text -可转债列表. - -Endpoint: ``api/v1/market/data/cb/cb-lists``. -Method: ``GET``. -Documented endpoint: ``get_cb_lists_handler``. - -Args: - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - -Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. -``` - -
- -

company_list

- -- 接口名称：公司列表 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/company-list` -- 参数：`stock_name`, `stock_code`, `page`, `page_size` -- 原始接口：`get_company_list` -- 来源文档：`公司列表.md` - -
-方法文档注释 +- 接口名称：飞兔股票评级Top5 +- HTTP：`GET` +- Path：`api/v1/market/data/feitu/stock-rating-top5` +- 参数：`date`, `variant`, `type` +- 来源文档：`飞兔股票评级Top5.md` +- 原始接口：`stock_rating_top5` ```text -公司列表. +飞兔股票评级Top5. -Endpoint: ``api/v1/market/data/company-list``. +Endpoint: ``api/v1/market/data/feitu/stock-rating-top5``. Method: ``GET``. -Documented endpoint: ``get_company_list``. +Documented endpoint: ``stock_rating_top5``. Args: - stock_name: 股票名称，精确匹配 (type: string; required: N). - stock_code: 股票代码，精确匹配 (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. + date: 日期 YYYYMMDD (type: string; required: Y). + variant: 档位，如 300001（30w01）、300000（30w），默认 300001 (type: string; required: N). + type: 市场：all / xshg / xshe / bjse，默认 all (type: StockRatingMarketFilter; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -3240,30 +2902,25 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

eastmoney_board_constituents

- -- 接口名称：东方财富板块成份股 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/eastmoney-board-constituents` -- 参数：`board_code` -- 原始接口：`eastmoney_board_constituents` -- 来源文档：`东方财富板块成份股.md` +

stock_share

-
-方法文档注释 +- 接口名称：股本 +- HTTP：`GET` +- Path：`api/v1/market/data/share/get-stock-share` +- 参数：`stock_code`, `date` +- 来源文档：`股本.md` +- 原始接口：`get_stock_share_handler` ```text -东方财富板块成份股. +股本. -Endpoint: ``api/v1/market/data/eastmoney-board-constituents``. +Endpoint: ``api/v1/market/data/share/get-stock-share``. Method: ``GET``. -Documented endpoint: ``eastmoney_board_constituents``. +Documented endpoint: ``get_stock_share_handler``. Args: - board_code: 板块代码，如 BK1024 (type: string; required: Y). + stock_code: 股票代码 (type: string; required: Y). + date: 日期 YYYYMMDD (type: string; required: Y). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -3275,32 +2932,25 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

stock_share_chg

-

eastmoney_board_daily_kline

- -- 接口名称：东方财富板块日线OHLC -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/eastmoney-board-daily-ohlc` -- 参数：`board_code`, `start_date`, `end_date`, `page`, `page_size` -- 原始接口：`eastmoney_board_daily_kline` -- 来源文档：`东方财富板块日线OHLC.md` - -
-方法文档注释 +- 接口名称：股东增减持 +- HTTP：`GET` +- Path：`api/v1/market/data/holder/stock-share-chg` +- 参数：`stock_code`, `is_last`, `page`, `page_size` +- 来源文档：`股东增减持.md` +- 原始接口：`stock_share_chg` ```text -东方财富板块日线OHLC. +股东增减持. -Endpoint: ``api/v1/market/data/eastmoney-board-daily-ohlc``. +Endpoint: ``api/v1/market/data/holder/stock-share-chg``. Method: ``GET``. -Documented endpoint: ``eastmoney_board_daily_kline``. +Documented endpoint: ``stock_share_chg``. Args: - board_code: 板块代码，如 BK1024 (type: string; required: Y). - start_date: 起始日期（含），YYYY-MM-DD 或 YYYYMMDD (type: string; required: N). - end_date: 截止日期（含），YYYY-MM-DD 或 YYYYMMDD (type: string; required: N). + stock_code: 标的代码，指定时返回该标的分页历史数据 (type: string; required: N). + is_last: 是否取所有标的最新一期，true 时按 page/page_size 分页 (type: bool; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -3317,30 +2967,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

eastmoney_board_latest_kline

+

stock_signal_latest_snapshot

-- 接口名称：东方财富板块最新OHLC -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/eastmoney-board-latest-ohlc` -- 参数：`board_code`, `page`, `page_size` -- 原始接口：`eastmoney_board_latest_kline` -- 来源文档：`东方财富板块最新OHLC.md` - -
-方法文档注释 +- 接口名称：信号最新快照 +- HTTP：`GET` +- Path：`api/v1/market/data/stock-signal-latest-snapshot` +- 参数：`signal_type`, `page`, `page_size` +- 来源文档：`信号最新快照.md` +- 原始接口：`stock_signal_latest_snapshot` ```text -东方财富板块最新OHLC. +信号最新快照. -Endpoint: ``api/v1/market/data/eastmoney-board-latest-ohlc``. +Endpoint: ``api/v1/market/data/stock-signal-latest-snapshot``. Method: ``GET``. -Documented endpoint: ``eastmoney_board_latest_kline``. +Documented endpoint: ``stock_signal_latest_snapshot``. Args: - board_code: 板块代码，如 BK1024；不传则返回全部板块最新K线 (type: string; required: N). + signal_type: 信号类型过滤，不传返回全部。可选值：`new_high_month`、`new_high_60d`、`new_high_120d`、`new_high_250d`、`new_low_month`、`new_low_60d`、`new_low_120d`、`new_low_250d`、`consecutive_up`、`consecutive_down`、`consecutive_vol_up`、`consecutive_vol_down`、`break_up_ma5`、`break_up_ma10`、`break_up_ma20`、`break_down_ma5`、`break_down_ma10`、`break_down_ma20`、`vol_price_rise`、`vol_price_fall` (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -3357,29 +3001,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

eastmoney_concept_boards

- -- 接口名称：东方财富概念板块 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/eastmoney-concept-boards` -- 参数：- -- 原始接口：`eastmoney_concept_boards` -- 来源文档：`东方财富概念板块.md` +

stock_trade

-
-方法文档注释 +- 接口名称：标的逐笔成交 +- HTTP：`GET` +- Path：`api/v1/market/data/daec/history/trades` +- 参数：`symbol` +- 来源文档：`标的逐笔成交.md` +- 原始接口：`stock_trade` ```text -东方财富概念板块. +股票分时成交. -Endpoint: ``api/v1/market/data/eastmoney-concept-boards``. +Endpoint: ``api/v1/market/data/daec/history/trades``. Method: ``GET``. -Documented endpoint: ``eastmoney_concept_boards``. +Documented endpoint: ``stock_trade``. Args: + symbol: 标的代码 (type: SymbolKey; required: Y). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -3391,32 +3030,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

eastmoney_dapan_flow

- -- 接口名称：东方财富大盘资金流 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/eastmoney-dapan-flow` -- 参数：`trade_date`, `start_date`, `end_date`, `page`, `page_size` -- 原始接口：`get_eastmoney_dapan_flow` -- 来源文档：`东方财富大盘资金流.md` +

stock_unlock

-
-方法文档注释 +- 接口名称：限售解禁 +- HTTP：`GET` +- Path：`api/v1/market/data/unlock/stock-unlock` +- 参数：`stock_code`, `page`, `page_size` +- 来源文档：`限售解禁.md` +- 原始接口：`stock_unlock_handler` ```text -东方财富大盘资金流. +限售解禁. -Endpoint: ``api/v1/market/data/eastmoney-dapan-flow``. +Endpoint: ``api/v1/market/data/unlock/stock-unlock``. Method: ``GET``. -Documented endpoint: ``get_eastmoney_dapan_flow``. +Documented endpoint: ``stock_unlock_handler``. Args: - trade_date: 交易日 YYYYMMDD；与 start_date/end_date 互斥 (type: string; required: N). - start_date: 区间起始日 YYYYMMDD；需与 end_date 同时提供 (type: string; required: N). - end_date: 区间结束日 YYYYMMDD；需与 start_date 同时提供 (type: string; required: N). + stock_code: 证券代码 (type: string; required: Y). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -3433,33 +3064,25 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

eastmoney_hk_index_daily_kline

- -- 接口名称：东方财富港股指数日K -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/eastmoney-hk-index-daily-kline` -- 参数：`index_code`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` -- 原始接口：`get_eastmoney_hk_index_daily_kline` -- 来源文档：`东方财富港股指数日K.md` +

stock_unlock_by_date

-
-方法文档注释 +- 接口名称：限售解禁按日期 +- HTTP：`GET` +- Path：`api/v1/market/data/unlock/stock-unlock-by-date` +- 参数：`start_date`, `end_date`, `page`, `page_size` +- 来源文档：`限售解禁按日期.md` +- 原始接口：`stock_unlock_by_date_handler` ```text -东方财富港股指数日K. +限售解禁按日期. -Endpoint: ``api/v1/market/data/eastmoney-hk-index-daily-kline``. +Endpoint: ``api/v1/market/data/unlock/stock-unlock-by-date``. Method: ``GET``. -Documented endpoint: ``get_eastmoney_hk_index_daily_kline``. +Documented endpoint: ``stock_unlock_by_date_handler``. Args: - index_code: 指数代码，如 HSI / HSCEI / HSTECH；不传返回全部指数 (type: string; required: N). - trade_date: 交易日 YYYY-MM-DD；与 start_date/end_date 互斥 (type: string; required: N). - start_date: 区间起始日 YYYY-MM-DD；需与 end_date 同时提供 (type: string; required: N). - end_date: 区间结束日 YYYY-MM-DD；需与 start_date 同时提供 (type: string; required: N). + start_date: 起始日期（YYYY-MM-DD） (type: string; required: Y). + end_date: 结束日期（YYYY-MM-DD） (type: string; required: Y). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -3476,33 +3099,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

eastmoney_market_valuation

- -- 接口名称：东方财富市场估值 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/eastmoney-market-valuation` -- 参数：`market_code`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` -- 原始接口：`get_eastmoney_market_valuation` -- 来源文档：`东方财富市场估值.md` +

suspension_list

-
-方法文档注释 +- 接口名称：停牌列表 +- HTTP：`GET` +- Path：`api/v1/market/data/suspension-list` +- 参数：`trade_date`, `page`, `page_size` +- 来源文档：`停牌列表.md` +- 原始接口：`suspension_list` ```text -东方财富市场估值. +停牌列表. -Endpoint: ``api/v1/market/data/eastmoney-market-valuation``. +Endpoint: ``api/v1/market/data/suspension-list``. Method: ``GET``. -Documented endpoint: ``get_eastmoney_market_valuation``. +Documented endpoint: ``suspension_list``. Args: - market_code: 市场代码，如 000001=上证指数、000300=沪深300；不传返回全部 (type: string; required: N). - trade_date: 交易日 YYYYMMDD；与 start_date/end_date 互斥 (type: string; required: N). - start_date: 区间起始日 YYYYMMDD；需与 end_date 同时提供 (type: string; required: N). - end_date: 区间结束日 YYYYMMDD；需与 start_date 同时提供 (type: string; required: N). + trade_date: 交易日，格式 YYYYMMDD，默认当天 (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -3519,32 +3133,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

eastmoney_rank

- -- 接口名称：东方财富股票排名 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/eastmoney-rank` -- 参数：`rank_group`, `market`, `trade_date` -- 原始接口：`eastmoney_rank` -- 来源文档：`东方财富股票排名.md` +

sz_hk_stock_connect_members

-
-方法文档注释 +- 接口名称：深股通成份 +- HTTP：`GET` +- Path：`api/v1/market/data/sz-hk-stock-connect-members` +- 参数：- +- 来源文档：`深股通成份.md` +- 原始接口：`sz_hk_stock_connect_members` ```text -东方财富股票排名. +深股通成份. -Endpoint: ``api/v1/market/data/eastmoney-rank``. +Endpoint: ``api/v1/market/data/sz-hk-stock-connect-members``. Method: ``GET``. -Documented endpoint: ``eastmoney_rank``. +Documented endpoint: ``sz_hk_stock_connect_members``. Args: - rank_group: 榜单组：`hot`（人气榜）/ `up`（飙升榜） (type: string; required: N). - market: 市场：`A`（A股）/ `HK`（港股）/ `US`（美股） (type: string; required: N). - trade_date: 交易日期，格式 `YYYY-MM-DD`，不传默认取最新 (type: string; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -3556,34 +3161,25 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

eastmoney_sector_flow

- -- 接口名称：东方财富板块资金流 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/eastmoney-sector-flow` -- 参数：`sector_code`, `sector_type`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` -- 原始接口：`get_eastmoney_sector_flow` -- 来源文档：`东方财富板块资金流.md` +

ths_all_board_kline

-
-方法文档注释 +- 接口名称：同花顺全板块K线 +- HTTP：`GET` +- Path：`api/v1/market/data/ths-all-board-kline` +- 参数：`start_date`, `end_date`, `page`, `page_size` +- 来源文档：`同花顺全板块K线.md` +- 原始接口：`ths_all_board_kline` ```text -东方财富板块资金流. +同花顺全板块K线. -Endpoint: ``api/v1/market/data/eastmoney-sector-flow``. +Endpoint: ``api/v1/market/data/ths-all-board-kline``. Method: ``GET``. -Documented endpoint: ``get_eastmoney_sector_flow``. +Documented endpoint: ``ths_all_board_kline``. Args: - sector_code: 板块代码，如 BK0488 (type: string; required: N). - sector_type: 板块类型：industry / concept / regional (type: string; required: N). - trade_date: 交易日 YYYYMMDD；与 start_date/end_date 互斥 (type: string; required: N). - start_date: 区间起始日 YYYYMMDD；需与 end_date 同时提供 (type: string; required: N). - end_date: 区间结束日 YYYYMMDD；需与 start_date 同时提供 (type: string; required: N). + start_date: 起始日期（含），YYYY-MM-DD 或 YYYYMMDD (type: string; required: N). + end_date: 截止日期（含），YYYY-MM-DD 或 YYYYMMDD (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -3600,33 +3196,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

ths_board_kline

-

eastmoney_stock_flow

- -- 接口名称：东方财富个股资金流 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/eastmoney-stock-flow` -- 参数：`symbol`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` -- 原始接口：`get_eastmoney_stock_flow` -- 来源文档：`东方财富个股资金流.md` - -
-方法文档注释 +- 接口名称：同花顺板块K线 +- HTTP：`GET` +- Path：`api/v1/market/data/ths-board-kline` +- 参数：`board_code`, `page`, `page_size` +- 来源文档：`同花顺板块K线.md` +- 原始接口：`ths_board_kline` ```text -东方财富个股资金流. +同花顺板块K线. -Endpoint: ``api/v1/market/data/eastmoney-stock-flow``. +Endpoint: ``api/v1/market/data/ths-board-kline``. Method: ``GET``. -Documented endpoint: ``get_eastmoney_stock_flow``. +Documented endpoint: ``ths_board_kline``. Args: - symbol: 股票代码，如 600522 (type: string; required: N). - trade_date: 交易日 YYYYMMDD；与 start_date/end_date 互斥 (type: string; required: N). - start_date: 区间起始日 YYYYMMDD；需与 end_date 同时提供 (type: string; required: N). - end_date: 区间结束日 YYYYMMDD；需与 start_date 同时提供 (type: string; required: N). + board_code: 板块代码，如 886056 (type: string; required: Y). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -3643,38 +3230,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

eastmoney_stock_valuation

- -- 接口名称：东方财富个股估值 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/eastmoney-stock-valuation` -- 参数：`symbol`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` -- 原始接口：`get_eastmoney_stock_valuation` -- 来源文档：`东方财富个股估值.md` +

ths_board_list

-
-方法文档注释 +- 接口名称：同花顺板块列表 +- HTTP：`GET` +- Path：`api/v1/market/data/ths-board-list` +- 参数：- +- 来源文档：`同花顺板块列表.md` +- 原始接口：`ths_board_list` ```text -东方财富个股估值. +同花顺板块列表. -Endpoint: ``api/v1/market/data/eastmoney-stock-valuation``. +Endpoint: ``api/v1/market/data/ths-board-list``. Method: ``GET``. -Documented endpoint: ``get_eastmoney_stock_valuation``. +Documented endpoint: ``ths_board_list``. Args: - symbol: 股票代码，如 000001；不传返回全部 (type: string; required: N). - trade_date: 交易日 YYYYMMDD；与 start_date/end_date 互斥 (type: string; required: N). - start_date: 区间起始日 YYYYMMDD；需与 end_date 同时提供 (type: string; required: N). - end_date: 区间结束日 YYYYMMDD；需与 start_date 同时提供 (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -3686,32 +3258,26 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

eastmoney_us_stock_daily_kline

- -- 接口名称：东方财富美股日OHLC -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/eastmoney-us-stock-daily-ohlc` -- 参数：`stock_code`, `start_date`, `end_date`, `page`, `page_size` -- 原始接口：`eastmoney_us_stock_daily_kline` -- 来源文档：`东方财富美股日OHLC.md` +

xueqiu_rank

-
-方法文档注释 +- 接口名称：雪球股票排名 +- HTTP：`GET` +- Path：`api/v1/market/data/xueqiu-rank` +- 参数：`rank_group`, `period`, `trade_date`, `page`, `page_size` +- 来源文档：`雪球股票排名.md` +- 原始接口：`xueqiu_rank` ```text -东方财富美股日OHLC. +雪球股票排名. -Endpoint: ``api/v1/market/data/eastmoney-us-stock-daily-ohlc``. +Endpoint: ``api/v1/market/data/xueqiu-rank``. Method: ``GET``. -Documented endpoint: ``eastmoney_us_stock_daily_kline``. +Documented endpoint: ``xueqiu_rank``. Args: - stock_code: 股票代码，如 AAPL (type: string; required: Y). - start_date: 起始日期（含），YYYY-MM-DD 或 YYYYMMDD；不传从最早开始 (type: string; required: N). - end_date: 截止日期（含），YYYY-MM-DD 或 YYYYMMDD；不传到最晚 (type: string; required: N). + rank_group: 榜单组：`follow`（关注）/ `tweet`（讨论）/ `deal`（交易） (type: string; required: N). + period: 周期：`7d`（本周新增）/ `total`（最热门） (type: string; required: N). + trade_date: 交易日期，格式 `YYYY-MM-DD`，不传默认取最新 (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -3728,32 +3294,26 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

eastmoney_us_stock_daily_ohlc

- -- 接口名称：东方财富美股日OHLC -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/eastmoney-us-stock-daily-ohlc` -- 参数：`stock_code`, `start_date`, `end_date`, `page`, `page_size` -- 原始接口：`eastmoney_us_stock_daily_kline` -- 来源文档：`东方财富美股日OHLC.md` +

yzxdr_detail

-
-方法文档注释 +- 接口名称：除权除息明细 +- HTTP：`GET` +- Path：`api/v1/market/data/yzxdr-detail` +- 参数：`year`, `quarter`, `stock_code`, `page`, `page_size` +- 来源文档：`除权除息明细.md` +- 原始接口：`get_yzxdr_detail` ```text -东方财富美股日OHLC. +除权除息明细. -Endpoint: ``api/v1/market/data/eastmoney-us-stock-daily-ohlc``. +Endpoint: ``api/v1/market/data/yzxdr-detail``. Method: ``GET``. -Documented endpoint: ``eastmoney_us_stock_daily_kline``. +Documented endpoint: ``get_yzxdr_detail``. Args: - stock_code: 股票代码，如 AAPL (type: string; required: Y). - start_date: 起始日期（含），YYYY-MM-DD 或 YYYYMMDD；不传从最早开始 (type: string; required: N). - end_date: 截止日期（含），YYYY-MM-DD 或 YYYYMMDD；不传到最晚 (type: string; required: N). + year: 年份（如 2026） (type: uint32; required: Y). + quarter: 季度，1-4 (type: uint32; required: Y). + stock_code: 股票代码，6 位数字 (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -3770,30 +3330,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

eastmoney_us_stock_latest_kline

- -- 接口名称：东方财富美股最新OHLC -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/eastmoney-us-stock-latest-ohlc` -- 参数：`stock_code`, `page`, `page_size` -- 原始接口：`eastmoney_us_stock_latest_kline` -- 来源文档：`东方财富美股最新OHLC.md` +

pledge_summary

-
-方法文档注释 +- 接口名称：股权质押汇总 +- HTTP：`GET` +- Path：`api/v1/market/data/pledge/pledge-summary` +- 参数：`page`, `page_size` +- 来源文档：`股权质押汇总.md` +- 原始接口：`stock_pledge_summary` ```text -东方财富美股最新OHLC. +股权质押汇总. -Endpoint: ``api/v1/market/data/eastmoney-us-stock-latest-ohlc``. +Endpoint: ``api/v1/market/data/pledge/pledge-summary``. Method: ``GET``. -Documented endpoint: ``eastmoney_us_stock_latest_kline``. +Documented endpoint: ``stock_pledge_summary``. Args: - stock_code: 股票代码，如 ADV；不传返回全部美股最新 K 线 (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -3810,30 +3363,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

eastmoney_us_stock_latest_ohlc

- -- 接口名称：东方财富美股最新OHLC -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/eastmoney-us-stock-latest-ohlc` -- 参数：`stock_code`, `page`, `page_size` -- 原始接口：`eastmoney_us_stock_latest_kline` -- 来源文档：`东方财富美股最新OHLC.md` +

stock_capital_flows

-
-方法文档注释 +- 接口名称：股票资金流向 +- HTTP：`GET` +- Path：`api/v1/market/data/stock-capital-flows` +- 参数：`date`, `page`, `page_size` +- 来源文档：`股票资金流向.md` +- 原始接口：`stock_capital_flows_paginated` ```text -东方财富美股最新OHLC. +股票资金流向. -Endpoint: ``api/v1/market/data/eastmoney-us-stock-latest-ohlc``. +Endpoint: ``api/v1/market/data/stock-capital-flows``. Method: ``GET``. -Documented endpoint: ``eastmoney_us_stock_latest_kline``. +Documented endpoint: ``stock_capital_flows_paginated``. Args: - stock_code: 股票代码，如 ADV；不传返回全部美股最新 K 线 (type: string; required: N). + date: 查询日期 YYYYMMDD；传入时查询该日 15:30 快照 (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -3850,35 +3397,26 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+### 港股数据 -

eastmoney_us_stock_list

+

company_hk

-- 接口名称：东方财富美股列表 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/eastmoney-us-stock-list` -- 参数：`refresh`, `page`, `page_size` -- 原始接口：`eastmoney_us_stock_list` -- 来源文档：`东方财富美股列表.md` - -
-方法文档注释 +- 接口名称：港股公司信息 +- HTTP：`GET` +- Path：`api/v1/market/data/hk/company-hk` +- 参数：`trade_code` +- 来源文档：`港股公司信息.md` +- 原始接口：`get_company_hk` ```text -东方财富美股列表. +港股公司信息. -Endpoint: ``api/v1/market/data/eastmoney-us-stock-list``. +Endpoint: ``api/v1/market/data/hk/company-hk``. Method: ``GET``. -Documented endpoint: ``eastmoney_us_stock_list``. +Documented endpoint: ``get_company_hk``. Args: - refresh: 为 true 时强制从 CSV 重新加载列表缓存 (type: bool; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. + trade_code: 港股交易代码 (type: string; required: Y). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -3890,29 +3428,32 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

eastmoney_hk_index_daily_kline

-

hk_sh_stock_connect_members

- -- 接口名称：沪港通成份 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/hk-sh-stock-connect-members` -- 参数：- -- 原始接口：`hk_sh_stock_connect_members` -- 来源文档：`沪港通成份.md` - -
-方法文档注释 +- 接口名称：东方财富港股指数日K +- HTTP：`GET` +- Path：`api/v1/market/data/eastmoney-hk-index-daily-kline` +- 参数：`index_code`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` +- 来源文档：`东方财富港股指数日K.md` +- 原始接口：`get_eastmoney_hk_index_daily_kline` ```text -沪港通成份. +东方财富港股指数日K. -Endpoint: ``api/v1/market/data/hk-sh-stock-connect-members``. +Endpoint: ``api/v1/market/data/eastmoney-hk-index-daily-kline``. Method: ``GET``. -Documented endpoint: ``hk_sh_stock_connect_members``. +Documented endpoint: ``get_eastmoney_hk_index_daily_kline``. Args: + index_code: 指数代码，如 HSI / HSCEI / HSTECH；不传返回全部指数 (type: string; required: N). + trade_date: 交易日 YYYY-MM-DD；与 start_date/end_date 互斥 (type: string; required: N). + start_date: 区间起始日 YYYY-MM-DD；需与 end_date 同时提供 (type: string; required: N). + end_date: 区间结束日 YYYY-MM-DD；需与 start_date 同时提供 (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -3924,29 +3465,33 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

hk_sz_stock_connect_members

- -- 接口名称：深港通成份 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/hk-sz-stock-connect-members` -- 参数：- -- 原始接口：`hk_sz_stock_connect_members` -- 来源文档：`深港通成份.md` +

hk_balance_bank

-
-方法文档注释 +- 接口名称：港股资产负债表 +- HTTP：`GET` +- Path：`api/v1/market/data/hk/hk-balance-bank` +- 参数：`trade_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` +- 来源文档：`港股资产负债表.md` +- 原始接口：`hk_balance_bank` ```text -深港通成份. +港股资产负债表. -Endpoint: ``api/v1/market/data/hk-sz-stock-connect-members``. +Endpoint: ``api/v1/market/data/hk/hk-balance-bank``. Method: ``GET``. -Documented endpoint: ``hk_sz_stock_connect_members``. +Documented endpoint: ``hk_balance_bank``. Args: + trade_code: 港股代码（支持 `700` / `00700.HK`） (type: string; required: N). + year: 报告期年份（如 2024），按 `end_date` 日历年过滤，需配 `report_type` (type: int32; required: N). + report_type: 报告类型：annual（年报）/ semi（半年报），需配 `year` (type: string; required: N). + start_date: 起始截止日期 YYYYMMDD，筛选 `end_date >= 此值` (type: int32; required: N). + end_date: 结束截止日期 YYYYMMDD，筛选 `end_date <= 此值` (type: int32; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -3958,29 +3503,33 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

index_description_all

+

hk_balance_gene

-- 接口名称：指数基础信息 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/index-description-all` -- 参数：- -- 原始接口：`index_description_all` -- 来源文档：`指数基础信息.md` - -
-方法文档注释 +- 接口名称：港股资产负债表 +- HTTP：`GET` +- Path：`api/v1/market/data/hk/hk-balance-gene` +- 参数：`trade_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` +- 来源文档：`港股资产负债表.md` +- 原始接口：`hk_balance_gene` ```text -指数基础信息. +港股资产负债表. -Endpoint: ``api/v1/market/data/index-description-all``. +Endpoint: ``api/v1/market/data/hk/hk-balance-gene``. Method: ``GET``. -Documented endpoint: ``index_description_all``. +Documented endpoint: ``hk_balance_gene``. Args: + trade_code: 港股代码（支持 `700` / `00700.HK`） (type: string; required: N). + year: 报告期年份（如 2024），按 `end_date` 日历年过滤，需配 `report_type` (type: int32; required: N). + report_type: 报告类型：annual（年报）/ semi（半年报），需配 `year` (type: string; required: N). + start_date: 起始截止日期 YYYYMMDD，筛选 `end_date >= 此值` (type: int32; required: N). + end_date: 结束截止日期 YYYYMMDD，筛选 `end_date <= 此值` (type: int32; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -3992,32 +3541,35 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

northbound

- -- 接口名称：北向资金交易 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/northbound` -- 参数：`date` -- 原始接口：`northbound` -- 来源文档：`北向资金交易.md` +

hk_balance_insur

-
-方法文档注释 +- 接口名称：港股资产负债表 +- HTTP：`GET` +- Path：`api/v1/market/data/hk/hk-balance-insur` +- 参数：`trade_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` +- 来源文档：`港股资产负债表.md` +- 原始接口：`hk_balance_insur` ```text -北向资金交易. +港股资产负债表. -Endpoint: ``api/v1/market/data/northbound``. +Endpoint: ``api/v1/market/data/hk/hk-balance-insur``. Method: ``GET``. -Documented endpoint: ``northbound``. +Documented endpoint: ``hk_balance_insur``. Args: - date: 交易日，格式 YYYYMMDD (type: string; required: Y). - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. + trade_code: 港股代码（支持 `700` / `00700.HK`） (type: string; required: N). + year: 报告期年份（如 2024），按 `end_date` 日历年过滤，需配 `report_type` (type: int32; required: N). + report_type: 报告类型：annual（年报）/ semi（半年报），需配 `year` (type: string; required: N). + start_date: 起始截止日期 YYYYMMDD，筛选 `end_date >= 此值` (type: int32; required: N). + end_date: 结束截止日期 YYYYMMDD，筛选 `end_date <= 此值` (type: int32; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. @@ -4027,30 +3579,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

nth_trade_date

+

hk_basinfo_get

-- 接口名称：第N个交易日 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/time/get-nth-trade-date` -- 参数：`n` -- 原始接口：`get_nth_trade_date` -- 来源文档：`第N个交易日.md` - -
-方法文档注释 +- 接口名称：港股个股信息 +- HTTP：`GET` +- Path：`api/v1/market/data/hk/hk-view` +- 参数：`hk_code` +- 来源文档：`港股个股信息.md` +- 原始接口：`get_hk_basinfo_get` ```text -第N个交易日. +港股个股信息. -Endpoint: ``api/v1/market/data/time/get-nth-trade-date``. +Endpoint: ``api/v1/market/data/hk/hk-view``. Method: ``GET``. -Documented endpoint: ``get_nth_trade_date``. +Documented endpoint: ``get_hk_basinfo_get``. Args: - n: 需要获取的前 N 个交易日，N >= 1 (type: uint32; required: Y). + hk_code: 港股代码，如 `00700.HK` (type: string; required: Y). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -4062,33 +3608,59 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

hk_basinfo_post

-

price_change

+- 接口名称：港股个股信息 +- HTTP：`GET` +- Path：`api/v1/market/data/hk/hk-view` +- 参数：`hk_code` +- 来源文档：`港股个股信息.md` +- 原始接口：`get_hk_basinfo_post` -- 接口名称：价格变动 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/price/get-price-change` -- 参数：`stock_code`, `base_date`, `n`, `direction` -- 原始接口：`get_price_change` -- 来源文档：`价格变动.md` +```text +港股个股信息. + +Endpoint: ``api/v1/market/data/hk/hk-view``. +Method: ``GET``. +Documented endpoint: ``get_hk_basinfo_post``. + +Args: + hk_code: 港股代码，如 `00700.HK` (type: string; required: Y). + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. -
-方法文档注释 +Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. +``` + +

hk_candlesticks

+ +- 接口名称：港股K线 +- HTTP：`GET` +- Path：`api/v1/market/data/hk/hk-candlesticks` +- 参数：`trade_code`, `interval_unit`, `until_date`, `since_date`, `interval_value`, `limit`, `adjust_kind` +- 来源文档：`港股K线.md` +- 原始接口：`get_hk_candlesticks` ```text -价格变动. +港股K线. -Endpoint: ``api/v1/market/data/price/get-price-change``. +Endpoint: ``api/v1/market/data/hk/hk-candlesticks``. Method: ``GET``. -Documented endpoint: ``get_price_change``. +Documented endpoint: ``get_hk_candlesticks``. Args: - stock_code: 目标股票 6 位纯数字代码，兼容沪市/深市/创业板/科创板 (type: string; required: Y). - base_date: 涨跌幅计算基准日，格式 YYYYMMDD (type: string; required: Y). - n: 需计算的有效交易日数量，建议不超过 365 (type: uint32; required: Y). - direction: 计算方向：forward（基准日为结束日）/ backward（基准日为开始日） (type: string; required: Y). + trade_code: 港股代码，如 `00700.HK` 或 `700` (type: string; required: Y). + interval_unit: 间隔单位：day / month / quarter / year (type: string; required: Y). + until_date: 结束日期（YYYY-MM-DD） (type: date; required: Y). + since_date: 开始日期（YYYY-MM-DD） (type: date; required: N). + interval_value: 间隔数值（当前仅支持 1） (type: int; required: N). + limit: 数量限制（保留最近 N 根） (type: int; required: N). + adjust_kind: 复权类型：forward(默认/前复权) / none(不复权) (type: string; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -4100,31 +3672,71 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

hk_cashflow

- +- 接口名称：港股现金流量表 +- HTTP：`GET` +- Path：`api/v1/market/data/hk/hk-cashflow` +- 参数：`stock_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` +- 来源文档：`港股现金流量表.md` +- 原始接口：`hk_cashflow` -- 接口名称：标的搜索 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/security/search` -- 参数：`query`, `limit` -- 原始接口：`search` -- 来源文档：`标的搜索.md` +```text +港股现金流量表. + +Endpoint: ``api/v1/market/data/hk/hk-cashflow``. +Method: ``GET``. +Documented endpoint: ``hk_cashflow``. + +Args: + stock_code: 港股代码（如 `00700.HK`） (type: string; required: N). + year: 报告期年份（如 2024），按 `end_date` 日历年过滤，需配 `report_type` (type: int32; required: N). + report_type: 报告类型：annual（年报）/ semi（半年报），需配 `year` (type: string; required: N). + start_date: 报告期范围下界 YYYYMMDD（含），过滤 `end_date >= 此值` (type: int32; required: N). + end_date: 报告期范围上界 YYYYMMDD（含），过滤 `end_date <= 此值` (type: int32; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + +Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. +``` -
-方法文档注释 +

hk_income_bank

+ +- 接口名称：港股利润表 +- HTTP：`GET` +- Path：`api/v1/market/data/hk/hk-income-bank` +- 参数：`trade_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` +- 来源文档：`港股利润表.md` +- 原始接口：`hk_income_bank` ```text -标的搜索. +港股利润表. -Endpoint: ``api/v1/market/security/search``. +Endpoint: ``api/v1/market/data/hk/hk-income-bank``. Method: ``GET``. -Documented endpoint: ``search``. +Documented endpoint: ``hk_income_bank``. Args: - query: 搜索关键词；支持名称、标的代码、拼音全拼/首字母；大小写不敏感，自动 trim (type: string; required: Y). - limit: 返回最大条数，默认 1 (type: int; required: N). + trade_code: 港股代码（支持 `700` / `00700.HK`） (type: string; required: N). + year: 报告期年份（如 2024），按 `end_date` 日历年过滤，需配 `report_type` (type: int32; required: N). + report_type: 报告类型：annual（年报）/ semi（半年报），需配 `year` (type: string; required: N). + start_date: 起始截止日期 YYYYMMDD，筛选 `end_date >= 此值` (type: int32; required: N). + end_date: 结束截止日期 YYYYMMDD，筛选 `end_date <= 此值` (type: int32; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -4136,34 +3748,71 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

hk_income_gene

-

semantic_search_news

+- 接口名称：港股利润表 +- HTTP：`GET` +- Path：`api/v1/market/data/hk/hk-income-gene` +- 参数：`trade_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` +- 来源文档：`港股利润表.md` +- 原始接口：`hk_income_gene` -- 接口名称：新闻语义搜索 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/semantic-search-news` -- 参数：`query`, `limit`, `year`, `start_time`, `end_time` -- 原始接口：`semantic_search_news_handler` -- 来源文档：`新闻语义搜索.md` +```text +港股利润表. -
-方法文档注释 +Endpoint: ``api/v1/market/data/hk/hk-income-gene``. +Method: ``GET``. +Documented endpoint: ``hk_income_gene``. + +Args: + trade_code: 港股代码（支持 `700` / `00700.HK`） (type: string; required: N). + year: 报告期年份（如 2024），按 `end_date` 日历年过滤，需配 `report_type` (type: int32; required: N). + report_type: 报告类型：annual（年报）/ semi（半年报），需配 `year` (type: string; required: N). + start_date: 起始截止日期 YYYYMMDD，筛选 `end_date >= 此值` (type: int32; required: N). + end_date: 结束截止日期 YYYYMMDD，筛选 `end_date <= 此值` (type: int32; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + +Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. +``` + +

hk_income_insur

+ +- 接口名称：港股利润表 +- HTTP：`GET` +- Path：`api/v1/market/data/hk/hk-income-insur` +- 参数：`trade_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` +- 来源文档：`港股利润表.md` +- 原始接口：`hk_income_insur` ```text -新闻语义搜索. +港股利润表. -Endpoint: ``api/v1/market/data/semantic-search-news``. +Endpoint: ``api/v1/market/data/hk/hk-income-insur``. Method: ``GET``. -Documented endpoint: ``semantic_search_news_handler``. +Documented endpoint: ``hk_income_insur``. Args: - query: 搜索文字 (type: string; required: Y). - limit: 返回条数，默认由服务端决定 (type: int; required: N). - year: 年份，限定搜索范围 (type: int; required: N). - start_time: 起始时间（带时区），与 end_time 同传时区间不超过 3 天 (type: datetime; required: N). - end_time: 结束时间（带时区），与 start_time 同传时区间不超过 3 天 (type: datetime; required: N). + trade_code: 港股代码（支持 `700` / `00700.HK`） (type: string; required: N). + year: 报告期年份（如 2024），按 `end_date` 日历年过滤，需配 `report_type` (type: int32; required: N). + report_type: 报告类型：annual（年报）/ semi（半年报），需配 `year` (type: string; required: N). + start_date: 起始截止日期 YYYYMMDD，筛选 `end_date >= 此值` (type: int32; required: N). + end_date: 结束截止日期 YYYYMMDD，筛选 `end_date <= 此值` (type: int32; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -4175,29 +3824,58 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

hk_valuatnanalyd

-

sh_hk_stock_connect_members

+- 接口名称：港股估值分析 +- HTTP：`GET` +- Path：`api/v1/market/data/hk/hk-valuatnanalyd` +- 参数：`trade_code`, `page`, `page_size` +- 来源文档：`港股估值分析.md` +- 原始接口：`get_hk_valuatnanalyd` -- 接口名称：沪股通成份 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/sh-hk-stock-connect-members` -- 参数：- -- 原始接口：`sh_hk_stock_connect_members` -- 来源文档：`沪股通成份.md` +```text +港股估值分析. -
-方法文档注释 +Endpoint: ``api/v1/market/data/hk/hk-valuatnanalyd``. +Method: ``GET``. +Documented endpoint: ``get_hk_valuatnanalyd``. + +Args: + trade_code: 港股代码（支持 `700` / `00700.HK`）；留空查全市场 (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + +Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. +``` + +

market_cap_hk

+ +- 接口名称：港股市值 +- HTTP：`GET` +- Path：`api/v1/market/data/hk/market-cap-hk` +- 参数：`trade_code` +- 来源文档：`港股市值.md` +- 原始接口：`get_market_cap_hk` ```text -沪股通成份. +港股市值. -Endpoint: ``api/v1/market/data/sh-hk-stock-connect-members``. +Endpoint: ``api/v1/market/data/hk/market-cap-hk``. Method: ``GET``. -Documented endpoint: ``sh_hk_stock_connect_members``. +Documented endpoint: ``get_market_cap_hk``. Args: + trade_code: 港股交易代码 (type: string; required: Y). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -4209,30 +3887,33 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+### 美股数据 -

southbound

+

eastmoney_us_stock_daily_kline

-- 接口名称：南向资金交易 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/southbound` -- 参数：`date` -- 原始接口：`southbound` -- 来源文档：`南向资金交易.md` - -
-方法文档注释 +- 接口名称：东方财富美股日OHLC +- HTTP：`GET` +- Path：`api/v1/market/data/eastmoney-us-stock-daily-ohlc` +- 参数：`stock_code`, `start_date`, `end_date`, `page`, `page_size` +- 来源文档：`东方财富美股日OHLC.md` +- 原始接口：`eastmoney_us_stock_daily_kline` ```text -南向资金交易. +东方财富美股日OHLC. -Endpoint: ``api/v1/market/data/southbound``. +Endpoint: ``api/v1/market/data/eastmoney-us-stock-daily-ohlc``. Method: ``GET``. -Documented endpoint: ``southbound``. +Documented endpoint: ``eastmoney_us_stock_daily_kline``. Args: - date: 交易日，格式 YYYYMMDD (type: string; required: Y). + stock_code: 股票代码，如 AAPL (type: string; required: Y). + start_date: 起始日期（含），YYYY-MM-DD 或 YYYYMMDD；不传从最早开始 (type: string; required: N). + end_date: 截止日期（含），YYYY-MM-DD 或 YYYYMMDD；不传到最晚 (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -4244,30 +3925,29 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

sw_industry_constituent_history

+

eastmoney_us_stock_latest_kline

-- 接口名称：申万行业成份股历史 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/sw-industry/constituent-history` -- 参数：`industry_code` -- 原始接口：`sw_industry_constituent_history` -- 来源文档：`申万行业成份股历史.md` - -
-方法文档注释 +- 接口名称：东方财富美股最新OHLC +- HTTP：`GET` +- Path：`api/v1/market/data/eastmoney-us-stock-latest-ohlc` +- 参数：`stock_code`, `page`, `page_size` +- 来源文档：`东方财富美股最新OHLC.md` +- 原始接口：`eastmoney_us_stock_latest_kline` ```text -申万行业成份股历史. +东方财富美股最新OHLC. -Endpoint: ``api/v1/market/data/sw-industry/constituent-history``. +Endpoint: ``api/v1/market/data/eastmoney-us-stock-latest-ohlc``. Method: ``GET``. -Documented endpoint: ``sw_industry_constituent_history``. +Documented endpoint: ``eastmoney_us_stock_latest_kline``. Args: - industry_code: 行业代码，带 .SI 后缀，如 801010.SI (type: string; required: Y). + stock_code: 股票代码，如 ADV；不传返回全部美股最新 K 线 (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -4279,33 +3959,62 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

eastmoney_us_stock_list

-

sw_industry_daily_metrics

+- 接口名称：东方财富美股列表 +- HTTP：`GET` +- Path：`api/v1/market/data/eastmoney-us-stock-list` +- 参数：`refresh`, `page`, `page_size` +- 来源文档：`东方财富美股列表.md` +- 原始接口：`eastmoney_us_stock_list` -- 接口名称：申万行业日度指标 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/sw-industry/daily-metrics` -- 参数：`level`, `start_date`, `end_date`, `industry_code`, `page`, `page_size` -- 原始接口：`sw_industry_daily_metrics` -- 来源文档：`申万行业日度指标.md` +```text +东方财富美股列表. -
-方法文档注释 +Endpoint: ``api/v1/market/data/eastmoney-us-stock-list``. +Method: ``GET``. +Documented endpoint: ``eastmoney_us_stock_list``. + +Args: + refresh: 为 true 时强制从 CSV 重新加载列表缓存 (type: bool; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + +Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. +``` + +

us_balance

+ +- 接口名称：美股资产负债表 +- HTTP：`GET` +- Path：`api/v1/market/data/us/us-balance` +- 参数：`stock_code`, `period`, `report_type`, `start_date`, `end_date`, `page`, `page_size` +- 来源文档：`美股资产负债表.md` +- 原始接口：`us_balance` ```text -申万行业日度指标. +美股资产负债表. -Endpoint: ``api/v1/market/data/sw-industry/daily-metrics``. +Endpoint: ``api/v1/market/data/us/us-balance``. Method: ``GET``. -Documented endpoint: ``sw_industry_daily_metrics``. +Documented endpoint: ``us_balance``. Args: - level: 行业层级：1/2/3 (type: int; required: Y). - start_date: 起始日期，YYYYMMDD (type: string; required: Y). - end_date: 截止日期，YYYYMMDD (type: string; required: Y). - industry_code: 行业代码，带 .SI 后缀，如 801010.SI (type: string; required: Y). + stock_code: 美股代码，纯代码不带后缀，如 NVDA (type: string; required: Y). + period: 财年（如 2024），匹配 stmt_year，非自然年 (type: int; required: N). + report_type: 报告期类型：Q1 / Q2 / Q3 / Q4 / H1 (type: string; required: N). + start_date: 报告期下界 YYYYMMDD（含），过滤 end_date (type: int; required: N). + end_date: 报告期上界 YYYYMMDD（含），过滤 end_date (type: int; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -4322,31 +4031,62 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

us_basic

-

sw_industry_overview

+- 接口名称：美股基础信息 +- HTTP：`GET` +- Path：`api/v1/market/data/us/us-basic` +- 参数：`stock_code`, `page`, `page_size` +- 来源文档：`美股基础信息.md` +- 原始接口：`us_basic` -- 接口名称：申万行业总览 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/sw-industry/overview` -- 参数：`date`, `level`, `page`, `page_size` -- 原始接口：`sw_industry_overview` -- 来源文档：`申万行业总览.md` +```text +美股基础信息. + +Endpoint: ``api/v1/market/data/us/us-basic``. +Method: ``GET``. +Documented endpoint: ``us_basic``. + +Args: + stock_code: 美股代码（可选），纯代码如 NVDA；不传则分页返回全部 (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. -
-方法文档注释 +Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. +``` + +

us_cashflow

+ +- 接口名称：美股现金流 +- HTTP：`GET` +- Path：`api/v1/market/data/us/us-cashflow` +- 参数：`stock_code`, `period`, `report_type`, `start_date`, `end_date`, `page`, `page_size` +- 来源文档：`美股现金流.md` +- 原始接口：`us_cashflow` ```text -申万行业总览. +美股现金流. -Endpoint: ``api/v1/market/data/sw-industry/overview``. +Endpoint: ``api/v1/market/data/us/us-cashflow``. Method: ``GET``. -Documented endpoint: ``sw_industry_overview``. +Documented endpoint: ``us_cashflow``. Args: - date: 交易日，格式 YYYYMMDD (type: string; required: Y). - level: 行业层级：1/2/3，不传返回全部 (type: int; required: N). + stock_code: 美股代码，纯代码不带后缀，如 NVDA (type: string; required: Y). + period: 财年（如 2024），匹配 stmt_year，非自然年 (type: int; required: N). + report_type: 报告期类型：Q1 / Q2 / Q3 / Q4 / H1 (type: string; required: N). + start_date: 报告期下界 YYYYMMDD（含），过滤 end_date (type: int; required: N). + end_date: 报告期上界 YYYYMMDD（含），过滤 end_date (type: int; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -4363,29 +4103,33 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

sz_hk_stock_connect_members

- -- 接口名称：深股通成份 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/sz-hk-stock-connect-members` -- 参数：- -- 原始接口：`sz_hk_stock_connect_members` -- 来源文档：`深股通成份.md` +

us_income

-
-方法文档注释 +- 接口名称：美股利润表 +- HTTP：`GET` +- Path：`api/v1/market/data/us/us-income` +- 参数：`stock_code`, `period`, `report_type`, `start_date`, `end_date`, `page`, `page_size` +- 来源文档：`美股利润表.md` +- 原始接口：`us_income` ```text -深股通成份. +美股利润表. -Endpoint: ``api/v1/market/data/sz-hk-stock-connect-members``. +Endpoint: ``api/v1/market/data/us/us-income``. Method: ``GET``. -Documented endpoint: ``sz_hk_stock_connect_members``. +Documented endpoint: ``us_income``. Args: + stock_code: 美股代码，纯代码不带后缀，如 NVDA (type: string; required: Y). + period: 财年（如 2024），匹配 stmt_year，非自然年 (type: int; required: N). + report_type: 报告期类型：Q1 / Q2 / Q3 / Q4 / H1 (type: string; required: N). + start_date: 报告期下界 YYYYMMDD（含），过滤 end_date (type: int; required: N). + end_date: 报告期上界 YYYYMMDD（含），过滤 end_date (type: int; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -4397,31 +4141,26 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

ths_all_board_kline

- -- 接口名称：同花顺全板块K线 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/ths-all-board-kline` -- 参数：`start_date`, `end_date`, `page`, `page_size` -- 原始接口：`ths_all_board_kline` -- 来源文档：`同花顺全板块K线.md` +

eastmoney_us_stock_daily_ohlc

-
-方法文档注释 +- 接口名称：东方财富美股日OHLC +- HTTP：`GET` +- Path：`api/v1/market/data/eastmoney-us-stock-daily-ohlc` +- 参数：`stock_code`, `start_date`, `end_date`, `page`, `page_size` +- 来源文档：`东方财富美股日OHLC.md` +- 原始接口：`eastmoney_us_stock_daily_kline` ```text -同花顺全板块K线. +东方财富美股日OHLC. -Endpoint: ``api/v1/market/data/ths-all-board-kline``. +Endpoint: ``api/v1/market/data/eastmoney-us-stock-daily-ohlc``. Method: ``GET``. -Documented endpoint: ``ths_all_board_kline``. +Documented endpoint: ``eastmoney_us_stock_daily_kline``. Args: - start_date: 起始日期（含），YYYY-MM-DD 或 YYYYMMDD (type: string; required: N). - end_date: 截止日期（含），YYYY-MM-DD 或 YYYYMMDD (type: string; required: N). + stock_code: 股票代码，如 AAPL (type: string; required: Y). + start_date: 起始日期（含），YYYY-MM-DD 或 YYYYMMDD；不传从最早开始 (type: string; required: N). + end_date: 截止日期（含），YYYY-MM-DD 或 YYYYMMDD；不传到最晚 (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -4438,30 +4177,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

ths_board_kline

- -- 接口名称：同花顺板块K线 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/ths-board-kline` -- 参数：`board_code`, `page`, `page_size` -- 原始接口：`ths_board_kline` -- 来源文档：`同花顺板块K线.md` +

eastmoney_us_stock_latest_ohlc

-
-方法文档注释 +- 接口名称：东方财富美股最新OHLC +- HTTP：`GET` +- Path：`api/v1/market/data/eastmoney-us-stock-latest-ohlc` +- 参数：`stock_code`, `page`, `page_size` +- 来源文档：`东方财富美股最新OHLC.md` +- 原始接口：`eastmoney_us_stock_latest_kline` ```text -同花顺板块K线. +东方财富美股最新OHLC. -Endpoint: ``api/v1/market/data/ths-board-kline``. +Endpoint: ``api/v1/market/data/eastmoney-us-stock-latest-ohlc``. Method: ``GET``. -Documented endpoint: ``ths_board_kline``. +Documented endpoint: ``eastmoney_us_stock_latest_kline``. Args: - board_code: 板块代码，如 886056 (type: string; required: Y). + stock_code: 股票代码，如 ADV；不传返回全部美股最新 K 线 (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -4478,29 +4211,28 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

ths_board_list

+### 指数专题 -- 接口名称：同花顺板块列表 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/ths-board-list` -- 参数：- -- 原始接口：`ths_board_list` -- 来源文档：`同花顺板块列表.md` +

global_index_daily_kline

-
-方法文档注释 +- 接口名称：全球指数日K线 +- HTTP：`GET` +- Path：`api/v1/market/data/global-index/daily-kline` +- 参数：`secid`, `start_date`, `end_date` +- 来源文档：`全球指数日K线.md` +- 原始接口：`global_index_daily_kline` ```text -同花顺板块列表. +全球指数日K线. -Endpoint: ``api/v1/market/data/ths-board-list``. +Endpoint: ``api/v1/market/data/global-index/daily-kline``. Method: ``GET``. -Documented endpoint: ``ths_board_list``. +Documented endpoint: ``global_index_daily_kline``. Args: + secid: 东方财富全球指数编码，如 100.NDX、100.DJIA、100.SPX、100.HSI、100.N225 (type: string; required: Y). + start_date: 开始日期 YYYY-MM-DD（含） (type: string; required: N). + end_date: 结束日期 YYYY-MM-DD（含） (type: string; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -4512,37 +4244,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

type_reports

- -- 接口名称：研报分类 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/report/type-reports` -- 参数：`rept_type`, `start_date`, `end_date`, `page`, `page_size` -- 原始接口：`type_reports` -- 来源文档：`研报分类.md` +

index_description_all

-
-方法文档注释 +- 接口名称：指数基础信息 +- HTTP：`GET` +- Path：`api/v1/market/data/index-description-all` +- 参数：- +- 来源文档：`指数基础信息.md` +- 原始接口：`index_description_all` ```text -研报分类. +指数基础信息. -Endpoint: ``api/v1/market/data/report/type-reports``. +Endpoint: ``api/v1/market/data/index-description-all``. Method: ``GET``. -Documented endpoint: ``type_reports``. +Documented endpoint: ``index_description_all``. Args: - rept_type: 研报类型：MacroReport / IndustryReport / BrokerMorningReport / StrategyReport / NewStockReport (type: string; required: Y). - start_date: 开始日期 YYYYMMDD (type: string; required: Y). - end_date: 结束日期 YYYYMMDD，不填默认与 `start_date` 相同 (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -4554,34 +4272,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

us_balance

+

index_description_list

-- 接口名称：美股资产负债表 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/us/us-balance` -- 参数：`stock_code`, `period`, `report_type`, `start_date`, `end_date`, `page`, `page_size` -- 原始接口：`us_balance` -- 来源文档：`美股资产负债表.md` - -
-方法文档注释 +- 接口名称：中证指数描述列表 +- HTTP：`GET` +- Path：`api/v1/market/data/index/index_description` +- 参数：`page`, `page_size` +- 来源文档：`中证指数描述列表.md` +- 原始接口：`index_description_list_handler` ```text -美股资产负债表. +中证指数描述列表. -Endpoint: ``api/v1/market/data/us/us-balance``. +Endpoint: ``api/v1/market/data/index/index_description``. Method: ``GET``. -Documented endpoint: ``us_balance``. +Documented endpoint: ``index_description_list_handler``. Args: - stock_code: 美股代码，纯代码不带后缀，如 NVDA (type: string; required: Y). - period: 财年（如 2024），匹配 stmt_year，非自然年 (type: int; required: N). - report_type: 报告期类型：Q1 / Q2 / Q3 / Q4 / H1 (type: string; required: N). - start_date: 报告期下界 YYYYMMDD（含），过滤 end_date (type: int; required: N). - end_date: 报告期上界 YYYYMMDD（含），过滤 end_date (type: int; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -4598,30 +4305,25 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

us_basic

- -- 接口名称：美股基础信息 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/us/us-basic` -- 参数：`stock_code`, `page`, `page_size` -- 原始接口：`us_basic` -- 来源文档：`美股基础信息.md` +

index_weight_list

-
-方法文档注释 +- 接口名称：指数权重列表 +- HTTP：`GET` +- Path：`api/v1/market/data/index/index_weight` +- 参数：`index_code`, `date`, `page`, `page_size` +- 来源文档：`指数权重列表.md` +- 原始接口：`index_weight_list_handler` ```text -美股基础信息. +指数权重列表. -Endpoint: ``api/v1/market/data/us/us-basic``. +Endpoint: ``api/v1/market/data/index/index_weight``. Method: ``GET``. -Documented endpoint: ``us_basic``. +Documented endpoint: ``index_weight_list_handler``. Args: - stock_code: 美股代码（可选），纯代码如 NVDA；不传则分页返回全部 (type: string; required: N). + index_code: 指数代码，如 000300（沪深300），为空会被拒 (type: string; required: Y). + date: 权重采集日期 YYYYMMDD（如 20260529），不传取最新期 (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -4638,34 +4340,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

us_cashflow

- -- 接口名称：美股现金流 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/us/us-cashflow` -- 参数：`stock_code`, `period`, `report_type`, `start_date`, `end_date`, `page`, `page_size` -- 原始接口：`us_cashflow` -- 来源文档：`美股现金流.md` +

index_weight_summary

-
-方法文档注释 +- 接口名称：指数权重汇总 +- HTTP：`GET` +- Path：`api/v1/market/data/index/index_weight_summary` +- 参数：`page`, `page_size` +- 来源文档：`指数权重汇总.md` +- 原始接口：`index_weight_summary_handler` ```text -美股现金流. +指数权重汇总. -Endpoint: ``api/v1/market/data/us/us-cashflow``. +Endpoint: ``api/v1/market/data/index/index_weight_summary``. Method: ``GET``. -Documented endpoint: ``us_cashflow``. +Documented endpoint: ``index_weight_summary_handler``. Args: - stock_code: 美股代码，纯代码不带后缀，如 NVDA (type: string; required: Y). - period: 财年（如 2024），匹配 stmt_year，非自然年 (type: int; required: N). - report_type: 报告期类型：Q1 / Q2 / Q3 / Q4 / H1 (type: string; required: N). - start_date: 报告期下界 YYYYMMDD（含），过滤 end_date (type: int; required: N). - end_date: 报告期上界 YYYYMMDD（含），过滤 end_date (type: int; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -4682,39 +4373,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

us_income

- -- 接口名称：美股利润表 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/us/us-income` -- 参数：`stock_code`, `period`, `report_type`, `start_date`, `end_date`, `page`, `page_size` -- 原始接口：`us_income` -- 来源文档：`美股利润表.md` +

sw_industry_constituent_history

-
-方法文档注释 +- 接口名称：申万行业成份股历史 +- HTTP：`GET` +- Path：`api/v1/market/data/sw-industry/constituent-history` +- 参数：`industry_code` +- 来源文档：`申万行业成份股历史.md` +- 原始接口：`sw_industry_constituent_history` ```text -美股利润表. +申万行业成份股历史. -Endpoint: ``api/v1/market/data/us/us-income``. +Endpoint: ``api/v1/market/data/sw-industry/constituent-history``. Method: ``GET``. -Documented endpoint: ``us_income``. +Documented endpoint: ``sw_industry_constituent_history``. Args: - stock_code: 美股代码，纯代码不带后缀，如 NVDA (type: string; required: Y). - period: 财年（如 2024），匹配 stmt_year，非自然年 (type: int; required: N). - report_type: 报告期类型：Q1 / Q2 / Q3 / Q4 / H1 (type: string; required: N). - start_date: 报告期下界 YYYYMMDD（含），过滤 end_date (type: int; required: N). - end_date: 报告期上界 YYYYMMDD（含），过滤 end_date (type: int; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. + industry_code: 行业代码，带 .SI 后缀，如 801010.SI (type: string; required: Y). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -4726,32 +4402,27 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

xueqiu_rank

+

sw_industry_daily_metrics

-- 接口名称：雪球股票排名 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/xueqiu-rank` -- 参数：`rank_group`, `period`, `trade_date`, `page`, `page_size` -- 原始接口：`xueqiu_rank` -- 来源文档：`雪球股票排名.md` - -
-方法文档注释 +- 接口名称：申万行业日度指标 +- HTTP：`GET` +- Path：`api/v1/market/data/sw-industry/daily-metrics` +- 参数：`level`, `start_date`, `end_date`, `industry_code`, `page`, `page_size` +- 来源文档：`申万行业日度指标.md` +- 原始接口：`sw_industry_daily_metrics` ```text -雪球股票排名. +申万行业日度指标. -Endpoint: ``api/v1/market/data/xueqiu-rank``. +Endpoint: ``api/v1/market/data/sw-industry/daily-metrics``. Method: ``GET``. -Documented endpoint: ``xueqiu_rank``. +Documented endpoint: ``sw_industry_daily_metrics``. Args: - rank_group: 榜单组：`follow`（关注）/ `tweet`（讨论）/ `deal`（交易） (type: string; required: N). - period: 周期：`7d`（本周新增）/ `total`（最热门） (type: string; required: N). - trade_date: 交易日期，格式 `YYYY-MM-DD`，不传默认取最新 (type: string; required: N). + level: 行业层级：1/2/3 (type: int; required: Y). + start_date: 起始日期，YYYYMMDD (type: string; required: Y). + end_date: 截止日期，YYYYMMDD (type: string; required: Y). + industry_code: 行业代码，带 .SI 后缀，如 801010.SI (type: string; required: Y). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -4768,32 +4439,25 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

sw_industry_overview

-

yzxdr_detail

- -- 接口名称：除权除息明细 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/yzxdr-detail` -- 参数：`year`, `quarter`, `stock_code`, `page`, `page_size` -- 原始接口：`get_yzxdr_detail` -- 来源文档：`除权除息明细.md` - -
-方法文档注释 +- 接口名称：申万行业总览 +- HTTP：`GET` +- Path：`api/v1/market/data/sw-industry/overview` +- 参数：`date`, `level`, `page`, `page_size` +- 来源文档：`申万行业总览.md` +- 原始接口：`sw_industry_overview` ```text -除权除息明细. +申万行业总览. -Endpoint: ``api/v1/market/data/yzxdr-detail``. +Endpoint: ``api/v1/market/data/sw-industry/overview``. Method: ``GET``. -Documented endpoint: ``get_yzxdr_detail``. +Documented endpoint: ``sw_industry_overview``. Args: - year: 年份（如 2026） (type: uint32; required: Y). - quarter: 季度，1-4 (type: uint32; required: Y). - stock_code: 股票代码，6 位数字 (type: string; required: N). + date: 交易日，格式 YYYYMMDD (type: string; required: Y). + level: 行业层级：1/2/3，不传返回全部 (type: int; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -4810,22 +4474,16 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -## ETF +### ETF专题 -

etf_adjust_factor

+

etf_adjust_factor

- 接口名称：ETF复权因子 -- 状态：可调用 -- HTTP 方法：`GET` +- HTTP：`GET` - Path：`api/v1/market/data/etf-adjust-factor` - 参数：`symbol`, `trade_date`, `start_date`, `end_date`, `offset`, `limit` -- 原始接口：`etf_adjust_factor` - 来源文档：`ETF复权因子.md` - -
-方法文档注释 +- 原始接口：`etf_adjust_factor` ```text ETF复权因子. @@ -4852,20 +4510,14 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

etf_components

+

etf_components

- 接口名称：ETF成份股 -- 状态：可调用 -- HTTP 方法：`GET` +- HTTP：`GET` - Path：`api/v1/market/data/etf-component` - 参数：`symbol` -- 原始接口：`get_etf_components_handler` - 来源文档：`ETF成份股.md` - -
-方法文档注释 +- 原始接口：`get_etf_components_handler` ```text ETF成份股. @@ -4887,20 +4539,14 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

etf_components_all

+

etf_components_all

- 接口名称：ETF成份列表 -- 状态：可调用 -- HTTP 方法：`GET` +- HTTP：`GET` - Path：`api/v1/market/data/etf-components-all` - 参数：- -- 原始接口：`etf_components_all` - 来源文档：`ETF成份列表.md` - -
-方法文档注释 +- 原始接口：`etf_components_all` ```text ETF成份列表. @@ -4921,20 +4567,14 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

etf_description_all

+

etf_description_all

- 接口名称：ETF基础信息 -- 状态：可调用 -- HTTP 方法：`GET` +- HTTP：`GET` - Path：`api/v1/market/data/etf-description-all` - 参数：- -- 原始接口：`etf_description_all` - 来源文档：`ETF基础信息.md` - -
-方法文档注释 +- 原始接口：`etf_description_all` ```text ETF基础信息. @@ -4955,20 +4595,14 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

etf_fund_export

+

etf_fund_export

- 接口名称：指数ETF基金导出 -- 状态：可调用 -- HTTP 方法：`GET` +- HTTP：`GET` - Path：`api/v1/market/data/etf/zhitou-etf` - 参数：`request_id`, `page`, `page_size` -- 原始接口：`etf_fund_export` - 来源文档：`指数ETF基金导出.md` - -
-方法文档注释 +- 原始接口：`etf_fund_export` ```text 指数ETF基金导出. @@ -4995,20 +4629,14 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

etf_pcf_list

+

etf_pcf_list

- 接口名称：ETF-PCF清单列表 -- 状态：可调用 -- HTTP 方法：`GET` +- HTTP：`GET` - Path：`api/v1/market/data/etf-pcf/etf-pcfs` - 参数：`date`, `page`, `page_size` -- 原始接口：`etf_pcf_list_handler` - 来源文档：`ETF-PCF清单列表.md` - -
-方法文档注释 +- 原始接口：`etf_pcf_list_handler` ```text ETF-PCF清单列表. @@ -5035,20 +4663,14 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

etf_pre

+

etf_pre

- 接口名称：ETF盘前数据 -- 状态：可调用 -- HTTP 方法：`GET` +- HTTP：`GET` - Path：`api/v1/market/data/etf-pre-data` - 参数：`date` -- 原始接口：`get_etf_pre` - 来源文档：`ETF盘前数据.md` - -
-方法文档注释 +- 原始接口：`get_etf_pre` ```text ETF盘前数据. @@ -5070,20 +4692,14 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

etf_pre_single

+

etf_pre_single

- 接口名称：单只ETF盘前数据 -- 状态：可调用 -- HTTP 方法：`GET` +- HTTP：`GET` - Path：`api/v1/market/data/etf-pre-single` - 参数：`symbol`, `date` -- 原始接口：`get_etf_pre_single_handler` - 来源文档：`单只ETF盘前数据.md` - -
-方法文档注释 +- 原始接口：`get_etf_pre_single_handler` ```text 单只ETF盘前数据. @@ -5106,192 +4722,26 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -## 指数 - -

index_description_list

- -- 接口名称：中证指数描述列表 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/index/index_description` -- 参数：`page`, `page_size` -- 原始接口：`index_description_list_handler` -- 来源文档：`中证指数描述列表.md` - -
-方法文档注释 - -```text -中证指数描述列表. - -Endpoint: ``api/v1/market/data/index/index_description``. -Method: ``GET``. -Documented endpoint: ``index_description_list_handler``. - -Args: - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - -Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. -``` - -
- -

index_weight_list

- -- 接口名称：指数权重列表 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/index/index_weight` -- 参数：`index_code`, `date`, `page`, `page_size` -- 原始接口：`index_weight_list_handler` -- 来源文档：`指数权重列表.md` - -
-方法文档注释 - -```text -指数权重列表. - -Endpoint: ``api/v1/market/data/index/index_weight``. -Method: ``GET``. -Documented endpoint: ``index_weight_list_handler``. - -Args: - index_code: 指数代码，如 000300（沪深300），为空会被拒 (type: string; required: Y). - date: 权重采集日期 YYYYMMDD（如 20260529），不传取最新期 (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - -Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. -``` - -
- -

index_weight_summary

- -- 接口名称：指数权重汇总 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/index/index_weight_summary` -- 参数：`page`, `page_size` -- 原始接口：`index_weight_summary_handler` -- 来源文档：`指数权重汇总.md` - -
-方法文档注释 - -```text -指数权重汇总. - -Endpoint: ``api/v1/market/data/index/index_weight_summary``. -Method: ``GET``. -Documented endpoint: ``index_weight_summary_handler``. - -Args: - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - -Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. -``` - -
- -## 港股 - -

company_hk

- -- 接口名称：港股公司信息 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/hk/company-hk` -- 参数：`trade_code` -- 原始接口：`get_company_hk` -- 来源文档：`港股公司信息.md` - -
-方法文档注释 - -```text -港股公司信息. - -Endpoint: ``api/v1/market/data/hk/company-hk``. -Method: ``GET``. -Documented endpoint: ``get_company_hk``. - -Args: - trade_code: 港股交易代码 (type: string; required: Y). - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - -Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. -``` - -
- -

hk_balance_bank

+### 公募基金 -- 接口名称：港股资产负债表 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/hk/hk-balance-bank` -- 参数：`trade_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` -- 原始接口：`hk_balance_bank` -- 来源文档：`港股资产负债表.md` +

fund_basicinfo

-
-方法文档注释 +- 接口名称：基金基础信息 +- HTTP：`GET` +- Path：`api/v1/market/data/fund/fund-basicinfo` +- 参数：`institution_code`, `page`, `page_size` +- 来源文档：`基金基础信息.md` +- 原始接口：`get_fund_basicinfo` ```text -港股资产负债表. +基金基础信息. -Endpoint: ``api/v1/market/data/hk/hk-balance-bank``. +Endpoint: ``api/v1/market/data/fund/fund-basicinfo``. Method: ``GET``. -Documented endpoint: ``hk_balance_bank``. +Documented endpoint: ``get_fund_basicinfo``. Args: - trade_code: 港股代码（支持 `700` / `00700.HK`） (type: string; required: N). - year: 报告期年份（如 2024），按 `end_date` 日历年过滤，需配 `report_type` (type: int32; required: N). - report_type: 报告类型：annual（年报）/ semi（半年报），需配 `year` (type: string; required: N). - start_date: 起始截止日期 YYYYMMDD，筛选 `end_date >= 此值` (type: int32; required: N). - end_date: 结束截止日期 YYYYMMDD，筛选 `end_date <= 此值` (type: int32; required: N). + institution_code: 基金代码 (type: string; required: Y). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -5308,39 +4758,25 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

hk_balance_gene

- -- 接口名称：港股资产负债表 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/hk/hk-balance-gene` -- 参数：`trade_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` -- 原始接口：`hk_balance_gene` -- 来源文档：`港股资产负债表.md` +

fund_cal_return

-
-方法文档注释 +- 接口名称：基金收益 +- HTTP：`GET` +- Path：`api/v1/market/data/fund/fund-cal-return` +- 参数：`institution_code`, `cal-type` +- 来源文档：`基金收益.md` +- 原始接口：`get_fund_cal_return` ```text -港股资产负债表. +基金收益. -Endpoint: ``api/v1/market/data/hk/hk-balance-gene``. +Endpoint: ``api/v1/market/data/fund/fund-cal-return``. Method: ``GET``. -Documented endpoint: ``hk_balance_gene``. +Documented endpoint: ``get_fund_cal_return``. Args: - trade_code: 港股代码（支持 `700` / `00700.HK`） (type: string; required: N). - year: 报告期年份（如 2024），按 `end_date` 日历年过滤，需配 `report_type` (type: int32; required: N). - report_type: 报告类型：annual（年报）/ semi（半年报），需配 `year` (type: string; required: N). - start_date: 起始截止日期 YYYYMMDD，筛选 `end_date >= 此值` (type: int32; required: N). - end_date: 结束截止日期 YYYYMMDD，筛选 `end_date <= 此值` (type: int32; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. + institution_code: 基金代码（6位数字） (type: string; required: Y). + cal_type: 查询区间：1M / 3M / 6M / 1Y / 3Y / 5Y / YTD（请求字段名为 `cal-type`） (type: string; required: Y). Request key: ``cal-type``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -5352,34 +4788,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

fund_nav

-

hk_balance_insur

- -- 接口名称：港股资产负债表 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/hk/hk-balance-insur` -- 参数：`trade_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` -- 原始接口：`hk_balance_insur` -- 来源文档：`港股资产负债表.md` - -
-方法文档注释 +- 接口名称：基金净值 +- HTTP：`GET` +- Path：`api/v1/market/data/fund/fund-nav` +- 参数：`institution_code`, `page`, `page_size` +- 来源文档：`基金净值.md` +- 原始接口：`get_fund_nav` ```text -港股资产负债表. +基金净值. -Endpoint: ``api/v1/market/data/hk/hk-balance-insur``. +Endpoint: ``api/v1/market/data/fund/fund-nav``. Method: ``GET``. -Documented endpoint: ``hk_balance_insur``. +Documented endpoint: ``get_fund_nav``. Args: - trade_code: 港股代码（支持 `700` / `00700.HK`） (type: string; required: N). - year: 报告期年份（如 2024），按 `end_date` 日历年过滤，需配 `report_type` (type: int32; required: N). - report_type: 报告类型：annual（年报）/ semi（半年报），需配 `year` (type: string; required: N). - start_date: 起始截止日期 YYYYMMDD，筛选 `end_date >= 此值` (type: int32; required: N). - end_date: 结束截止日期 YYYYMMDD，筛选 `end_date <= 此值` (type: int32; required: N). + institution_code: 基金代码 (type: string; required: Y). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -5396,30 +4822,28 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

fund_overview

-

hk_basinfo_get

- -- 接口名称：港股个股信息 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/hk/hk-view` -- 参数：`hk_code` -- 原始接口：`get_hk_basinfo_get` -- 来源文档：`港股个股信息.md` - -
-方法文档注释 +- 接口名称：基金总览 +- HTTP：`GET` +- Path：`api/v1/market/data/fund/fund-overview` +- 参数：`page`, `page_size` +- 来源文档：`基金总览.md` +- 原始接口：`get_fund_overview` ```text -港股个股信息. +基金总览. -Endpoint: ``api/v1/market/data/hk/hk-view``. +Endpoint: ``api/v1/market/data/fund/fund-overview``. Method: ``GET``. -Documented endpoint: ``get_hk_basinfo_get``. +Documented endpoint: ``get_fund_overview``. Args: - hk_code: 港股代码，如 `00700.HK` (type: string; required: Y). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -5431,30 +4855,28 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

fund_support_symbols

-

hk_basinfo_post

- -- 接口名称：港股个股信息 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/hk/hk-view` -- 参数：`hk_code` -- 原始接口：`get_hk_basinfo_post` -- 来源文档：`港股个股信息.md` - -
-方法文档注释 +- 接口名称：基金支持标的 +- HTTP：`GET` +- Path：`api/v1/market/data/fund/fund-support-symbols` +- 参数：`page`, `page_size` +- 来源文档：`基金支持标的.md` +- 原始接口：`get_fund_support_symbols` ```text -港股个股信息. +基金支持标的. -Endpoint: ``api/v1/market/data/hk/hk-view``. +Endpoint: ``api/v1/market/data/fund/fund-support-symbols``. Method: ``GET``. -Documented endpoint: ``get_hk_basinfo_post``. +Documented endpoint: ``get_fund_support_symbols``. Args: - hk_code: 港股代码，如 `00700.HK` (type: string; required: Y). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -5466,36 +4888,27 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+### 期货数据 -

hk_candlesticks

+

china_futures_base_data

-- 接口名称：港股K线 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/hk/hk-candlesticks` -- 参数：`trade_code`, `interval_unit`, `until_date`, `since_date`, `interval_value`, `limit`, `adjust_kind` -- 原始接口：`get_hk_candlesticks` -- 来源文档：`港股K线.md` - -
-方法文档注释 +- 接口名称：中国期货基础数据 +- HTTP：`GET` +- Path：`api/v1/market/data/futures/futures-base-data` +- 参数：`trade_date`, `symbol` +- 来源文档：`中国期货基础数据.md` +- 原始接口：`get_china_futures_base_data_handler` ```text -港股K线. +中国期货基础数据. -Endpoint: ``api/v1/market/data/hk/hk-candlesticks``. +Endpoint: ``api/v1/market/data/futures/futures-base-data``. Method: ``GET``. -Documented endpoint: ``get_hk_candlesticks``. +Documented endpoint: ``get_china_futures_base_data_handler``. Args: - trade_code: 港股代码，如 `00700.HK` 或 `700` (type: string; required: Y). - interval_unit: 间隔单位：day / month / quarter / year (type: string; required: Y). - until_date: 结束日期（YYYY-MM-DD） (type: date; required: Y). - since_date: 开始日期（YYYY-MM-DD） (type: date; required: N). - interval_value: 间隔数值（当前仅支持 1） (type: int; required: N). - limit: 数量限制（保留最近 N 根） (type: int; required: N). - adjust_kind: 复权类型：forward(默认/前复权) / none(不复权) (type: string; required: N). + trade_date: 交易日 YYYYMMDD；不传则使用前一交易日（CST） (type: int; required: N). + symbol: WIND 合约全码如 A2605.DCE；大小写不敏感；不传或空表示该日全部 (type: string; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -5507,39 +4920,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

hk_cashflow

- -- 接口名称：港股现金流量表 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/hk/hk-cashflow` -- 参数：`stock_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` -- 原始接口：`hk_cashflow` -- 来源文档：`港股现金流量表.md` +

china_futures_lists

-
-方法文档注释 +- 接口名称：中国期货列表 +- HTTP：`GET` +- Path：`api/v1/market/data/futures/futures-lists` +- 参数：`trade_date` +- 来源文档：`中国期货列表.md` +- 原始接口：`get_china_futures_lists_handler` ```text -港股现金流量表. +中国期货列表. -Endpoint: ``api/v1/market/data/hk/hk-cashflow``. +Endpoint: ``api/v1/market/data/futures/futures-lists``. Method: ``GET``. -Documented endpoint: ``hk_cashflow``. +Documented endpoint: ``get_china_futures_lists_handler``. Args: - stock_code: 港股代码（如 `00700.HK`） (type: string; required: N). - year: 报告期年份（如 2024），按 `end_date` 日历年过滤，需配 `report_type` (type: int32; required: N). - report_type: 报告类型：annual（年报）/ semi（半年报），需配 `year` (type: string; required: N). - start_date: 报告期范围下界 YYYYMMDD（含），过滤 `end_date >= 此值` (type: int32; required: N). - end_date: 报告期范围上界 YYYYMMDD（含），过滤 `end_date <= 此值` (type: int32; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. + trade_date: 交易日 YYYYMMDD；不传则使用前一交易日（CST） (type: int; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -5551,34 +4949,30 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

hk_income_bank

+

eastmoney_futures_position

-- 接口名称：港股利润表 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/hk/hk-income-bank` -- 参数：`trade_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` -- 原始接口：`hk_income_bank` -- 来源文档：`港股利润表.md` - -
-方法文档注释 +- 接口名称：东方财富期货持仓 +- HTTP：`GET` +- Path：`api/v1/market/data/eastmoney-futures-position` +- 参数：`exchange`, `variety_code`, `contract_code`, `trade_date`, `start_date`, `end_date`, `member_name_abbr`, `page`, `page_size` +- 来源文档：`东方财富期货持仓.md` +- 原始接口：`get_eastmoney_futures_position` ```text -港股利润表. +东方财富期货持仓. -Endpoint: ``api/v1/market/data/hk/hk-income-bank``. +Endpoint: ``api/v1/market/data/eastmoney-futures-position``. Method: ``GET``. -Documented endpoint: ``hk_income_bank``. +Documented endpoint: ``get_eastmoney_futures_position``. Args: - trade_code: 港股代码（支持 `700` / `00700.HK`） (type: string; required: N). - year: 报告期年份（如 2024），按 `end_date` 日历年过滤，需配 `report_type` (type: int32; required: N). - report_type: 报告类型：annual（年报）/ semi（半年报），需配 `year` (type: string; required: N). - start_date: 起始截止日期 YYYYMMDD，筛选 `end_date >= 此值` (type: int32; required: N). - end_date: 结束截止日期 YYYYMMDD，筛选 `end_date <= 此值` (type: int32; required: N). + exchange: 交易所代码：shfe / dce / czce / cffex / ine / gfe (type: string; required: N). + variety_code: 品种代码，如 cu / au / al / IF (type: string; required: N). + contract_code: 合约代码，如 CU2607 / AU2608 (type: string; required: N). + trade_date: 交易日 YYYYMMDD；与 start_date/end_date 互斥 (type: string; required: N). + start_date: 区间起始日 YYYYMMDD；需与 end_date 同时提供 (type: string; required: N). + end_date: 区间结束日 YYYYMMDD；需与 start_date 同时提供 (type: string; required: N). + member_name_abbr: 会员简称 (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -5595,39 +4989,28 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

hk_income_gene

- -- 接口名称：港股利润表 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/hk/hk-income-gene` -- 参数：`trade_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` -- 原始接口：`hk_income_gene` -- 来源文档：`港股利润表.md` +

futures_contract_kline

-
-方法文档注释 +- 接口名称：期货合约K线 +- HTTP：`GET` +- Path：`api/v1/market/data/futures/kline` +- 参数：`symbol`, `interval`, `start`, `end`, `limit` +- 来源文档：`期货合约K线.md` +- 原始接口：`futures_contract_kline` ```text -港股利润表. +期货合约K线. -Endpoint: ``api/v1/market/data/hk/hk-income-gene``. +Endpoint: ``api/v1/market/data/futures/kline``. Method: ``GET``. -Documented endpoint: ``hk_income_gene``. +Documented endpoint: ``futures_contract_kline``. Args: - trade_code: 港股代码（支持 `700` / `00700.HK`） (type: string; required: N). - year: 报告期年份（如 2024），按 `end_date` 日历年过滤，需配 `report_type` (type: int32; required: N). - report_type: 报告类型：annual（年报）/ semi（半年报），需配 `year` (type: string; required: N). - start_date: 起始截止日期 YYYYMMDD，筛选 `end_date >= 此值` (type: int32; required: N). - end_date: 结束截止日期 YYYYMMDD，筛选 `end_date <= 此值` (type: int32; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. + symbol: WIND 合约全码，如 A2605.DCE (type: string; required: Y). + interval: 周期，默认 1min；可选 1min/5min/15min/30min/60min/daily/weekly/monthly/quarterly/yearly (type: string; required: N). + start: 开始时间戳（毫秒）；与 end 跨度 ≤3 天；仅 start 表示 [start,+∞) (type: int64; required: N). + end: 结束时间戳（毫秒，闭区间）；须与 start 同时传入，禁止只传 end (type: int64; required: N). + limit: 最大返回条数，默认 500 (type: int; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -5639,39 +5022,25 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

hk_income_insur

- -- 接口名称：港股利润表 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/hk/hk-income-insur` -- 参数：`trade_code`, `year`, `report_type`, `start_date`, `end_date`, `page`, `page_size` -- 原始接口：`hk_income_insur` -- 来源文档：`港股利润表.md` +

major_contract

-
-方法文档注释 +- 接口名称：重大合同 +- HTTP：`GET` +- Path：`api/v1/market/data/corporate/contract` +- 参数：`start_date`, `end_date` +- 来源文档：`重大合同.md` +- 原始接口：`major_contract` ```text -港股利润表. +重大合同. -Endpoint: ``api/v1/market/data/hk/hk-income-insur``. +Endpoint: ``api/v1/market/data/corporate/contract``. Method: ``GET``. -Documented endpoint: ``hk_income_insur``. +Documented endpoint: ``major_contract``. Args: - trade_code: 港股代码（支持 `700` / `00700.HK`） (type: string; required: N). - year: 报告期年份（如 2024），按 `end_date` 日历年过滤，需配 `report_type` (type: int32; required: N). - report_type: 报告类型：annual（年报）/ semi（半年报），需配 `year` (type: string; required: N). - start_date: 起始截止日期 YYYYMMDD，筛选 `end_date >= 此值` (type: int32; required: N). - end_date: 结束截止日期 YYYYMMDD，筛选 `end_date <= 此值` (type: int32; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. + start_date: 起始日期（YYYYMMDD），区间跨度 ≤ 3 天 (type: string; required: Y). + end_date: 结束日期（YYYYMMDD），区间跨度 ≤ 3 天 (type: string; required: Y). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -5683,30 +5052,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

hk_valuatnanalyd

- -- 接口名称：港股估值分析 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/hk/hk-valuatnanalyd` -- 参数：`trade_code`, `page`, `page_size` -- 原始接口：`get_hk_valuatnanalyd` -- 来源文档：`港股估值分析.md` +

major_contract_by_symbol

-
-方法文档注释 +- 接口名称：重大合同按标的 +- HTTP：`GET` +- Path：`api/v1/market/data/corporate/contract/by-symbol` +- 参数：`symbol`, `page`, `page_size` +- 来源文档：`重大合同按标的.md` +- 原始接口：`major_contract_by_symbol` ```text -港股估值分析. +重大合同按标的. -Endpoint: ``api/v1/market/data/hk/hk-valuatnanalyd``. +Endpoint: ``api/v1/market/data/corporate/contract/by-symbol``. Method: ``GET``. -Documented endpoint: ``get_hk_valuatnanalyd``. +Documented endpoint: ``major_contract_by_symbol``. Args: - trade_code: 港股代码（支持 `700` / `00700.HK`）；留空查全市场 (type: string; required: N). + symbol: 证券代码（标的） (type: string; required: Y). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -5723,30 +5086,28 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

major_contract_summary

-

market_cap_hk

- -- 接口名称：港股市值 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/hk/market-cap-hk` -- 参数：`trade_code` -- 原始接口：`get_market_cap_hk` -- 来源文档：`港股市值.md` - -
-方法文档注释 +- 接口名称：重大合同汇总 +- HTTP：`GET` +- Path：`api/v1/market/data/corporate/contract/summary` +- 参数：`page`, `page_size` +- 来源文档：`重大合同汇总.md` +- 原始接口：`major_contract_summary` ```text -港股市值. +重大合同汇总. -Endpoint: ``api/v1/market/data/hk/market-cap-hk``. +Endpoint: ``api/v1/market/data/corporate/contract/summary``. Method: ``GET``. -Documented endpoint: ``get_market_cap_hk``. +Documented endpoint: ``major_contract_summary``. Args: - trade_code: 港股交易代码 (type: string; required: Y). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -5758,34 +5119,30 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

eastmoney_futures_strange

-

stk_ah_comparison

- -- 接口名称：AH股对比 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/hk/stk-ah-comparison` -- 参数：`hk_code`, `ts_code`, `trade_date`, `start_date`, `end_date`, `page`, `page_size` -- 原始接口：`get_stk_ah_comparison` -- 来源文档：`AH股对比.md` - -
-方法文档注释 +- 接口名称：东方财富期货持仓 +- HTTP：`GET` +- Path：`api/v1/market/data/eastmoney-futures-position` +- 参数：`exchange`, `variety_code`, `contract_code`, `trade_date`, `start_date`, `end_date`, `member_name_abbr`, `page`, `page_size` +- 来源文档：`东方财富期货持仓.md` +- 原始接口：`get_eastmoney_futures_position` ```text -AH股对比. +东方财富期货持仓. -Endpoint: ``api/v1/market/data/hk/stk-ah-comparison``. +Endpoint: ``api/v1/market/data/eastmoney-futures-position``. Method: ``GET``. -Documented endpoint: ``get_stk_ah_comparison``. +Documented endpoint: ``get_eastmoney_futures_position``. Args: - hk_code: 港股股票代码，支持 `700` 或 `00700.HK` (type: string; required: N). - ts_code: A 股股票代码，格式 `xxxxxx.SH/SZ/BJ` (type: string; required: N). - trade_date: 交易日期 YYYYMMDD (type: int32; required: N). - start_date: 起始日期 YYYYMMDD (type: int32; required: N). - end_date: 结束日期 YYYYMMDD (type: int32; required: N). + exchange: 交易所代码：shfe / dce / czce / cffex / ine / gfe (type: string; required: N). + variety_code: 品种代码，如 cu / au / al / IF (type: string; required: N). + contract_code: 合约代码，如 CU2607 / AU2608 (type: string; required: N). + trade_date: 交易日 YYYYMMDD；与 start_date/end_date 互斥 (type: string; required: N). + start_date: 区间起始日 YYYYMMDD；需与 end_date 同时提供 (type: string; required: N). + end_date: 区间结束日 YYYYMMDD；需与 start_date 同时提供 (type: string; required: N). + member_name_abbr: 会员简称 (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -5802,37 +5159,28 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -## 基金 - -

fund_basicinfo

+

futures_kline

-- 接口名称：基金基础信息 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/fund/fund-basicinfo` -- 参数：`institution_code`, `page`, `page_size` -- 原始接口：`get_fund_basicinfo` -- 来源文档：`基金基础信息.md` - -
-方法文档注释 +- 接口名称：期货合约K线 +- HTTP：`GET` +- Path：`api/v1/market/data/futures/kline` +- 参数：`symbol`, `interval`, `start`, `end`, `limit` +- 来源文档：`期货合约K线.md` +- 原始接口：`futures_contract_kline` ```text -基金基础信息. +期货合约K线. -Endpoint: ``api/v1/market/data/fund/fund-basicinfo``. +Endpoint: ``api/v1/market/data/futures/kline``. Method: ``GET``. -Documented endpoint: ``get_fund_basicinfo``. +Documented endpoint: ``futures_contract_kline``. Args: - institution_code: 基金代码 (type: string; required: Y). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. + symbol: WIND 合约全码，如 A2605.DCE (type: string; required: Y). + interval: 周期，默认 1min；可选 1min/5min/15min/30min/60min/daily/weekly/monthly/quarterly/yearly (type: string; required: N). + start: 开始时间戳（毫秒）；与 end 跨度 ≤3 天；仅 start 表示 [start,+∞) (type: int64; required: N). + end: 结束时间戳（毫秒，闭区间）；须与 start 同时传入，禁止只传 end (type: int64; required: N). + limit: 最大返回条数，默认 500 (type: int; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -5844,31 +5192,26 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+### 债券专题 -

fund_cal_return

- -- 接口名称：基金收益 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/fund/fund-cal-return` -- 参数：`institution_code`, `cal-type` -- 原始接口：`get_fund_cal_return` -- 来源文档：`基金收益.md` +

cb_base_data

-
-方法文档注释 +- 接口名称：可转债基础数据 +- HTTP：`GET` +- Path：`api/v1/market/data/cb/cb-base-data` +- 参数：`symbol_code` +- 来源文档：`可转债基础数据.md` +- 原始接口：`get_cb_base_data_handler` ```text -基金收益. +可转债基础数据. -Endpoint: ``api/v1/market/data/fund/fund-cal-return``. +Endpoint: ``api/v1/market/data/cb/cb-base-data``. Method: ``GET``. -Documented endpoint: ``get_fund_cal_return``. +Documented endpoint: ``get_cb_base_data_handler``. Args: - institution_code: 基金代码（6位数字） (type: string; required: Y). - cal_type: 查询区间：1M / 3M / 6M / 1Y / 3Y / 5Y / YTD（请求字段名为 `cal-type`） (type: string; required: Y). Request key: ``cal-type``. + symbol_code: 转债代码 (type: string; required: Y). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -5880,35 +5223,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

cb_lists

-

fund_nav

- -- 接口名称：基金净值 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/fund/fund-nav` -- 参数：`institution_code`, `page`, `page_size` -- 原始接口：`get_fund_nav` -- 来源文档：`基金净值.md` - -
-方法文档注释 +- 接口名称：可转债列表 +- HTTP：`GET` +- Path：`api/v1/market/data/cb/cb-lists` +- 参数：- +- 来源文档：`可转债列表.md` +- 原始接口：`get_cb_lists_handler` ```text -基金净值. +可转债列表. -Endpoint: ``api/v1/market/data/fund/fund-nav``. +Endpoint: ``api/v1/market/data/cb/cb-lists``. Method: ``GET``. -Documented endpoint: ``get_fund_nav``. +Documented endpoint: ``get_cb_lists_handler``. Args: - institution_code: 基金代码 (type: string; required: Y). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -5920,29 +5251,28 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

fund_overview

+### 宏观经济 -- 接口名称：基金总览 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/fund/fund-overview` -- 参数：`page`, `page_size` -- 原始接口：`get_fund_overview` -- 来源文档：`基金总览.md` +

baidu_financial_calendar

-
-方法文档注释 +- 接口名称：百度财经日历 +- HTTP：`GET` +- Path：`api/v1/market/data/finance/financial-calendar/baidu` +- 参数：`start_date`, `end_date`, `category`, `page`, `page_size` +- 来源文档：`百度财经日历.md` +- 原始接口：`baidu_financial_calendar` ```text -基金总览. +百度财经日历. -Endpoint: ``api/v1/market/data/fund/fund-overview``. +Endpoint: ``api/v1/market/data/finance/financial-calendar/baidu``. Method: ``GET``. -Documented endpoint: ``get_fund_overview``. +Documented endpoint: ``baidu_financial_calendar``. Args: + start_date: 起始日期 (type: string; required: Y). + end_date: 结束日期（与 start_date 间隔 ≤ 3 天） (type: string; required: Y). + category: 筛选大类：`economic` / `ipo` / `report_time` / `trade_reminder`；不传返回全部 (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -5959,34 +5289,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

fund_support_symbols

- -- 接口名称：基金支持标的 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/fund/fund-support-symbols` -- 参数：`page`, `page_size` -- 原始接口：`get_fund_support_symbols` -- 来源文档：`基金支持标的.md` +

consumer_credit_monthly

-
-方法文档注释 +- 接口名称：社融信贷 +- HTTP：`GET` +- Path：`api/v1/market/data/economic/china-credit-loans` +- 参数：- +- 来源文档：`社融信贷.md` +- 原始接口：`consumer_credit_monthly` ```text -基金支持标的. +社融信贷. -Endpoint: ``api/v1/market/data/fund/fund-support-symbols``. +Endpoint: ``api/v1/market/data/economic/china-credit-loans``. Method: ``GET``. -Documented endpoint: ``get_fund_support_symbols``. +Documented endpoint: ``consumer_credit_monthly``. Args: - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -5998,33 +5317,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -## 期货 - -

china_futures_base_data

- -- 接口名称：中国期货基础数据 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/futures/futures-base-data` -- 参数：`trade_date`, `symbol` -- 原始接口：`get_china_futures_base_data_handler` -- 来源文档：`中国期货基础数据.md` +

consumer_customs_trade_monthly

-
-方法文档注释 +- 接口名称：进出口 +- HTTP：`GET` +- Path：`api/v1/market/data/economic/china-customs-trade` +- 参数：- +- 来源文档：`进出口.md` +- 原始接口：`consumer_customs_trade_monthly` ```text -中国期货基础数据. +进出口. -Endpoint: ``api/v1/market/data/futures/futures-base-data``. +Endpoint: ``api/v1/market/data/economic/china-customs-trade``. Method: ``GET``. -Documented endpoint: ``get_china_futures_base_data_handler``. +Documented endpoint: ``consumer_customs_trade_monthly``. Args: - trade_date: 交易日 YYYYMMDD；不传则使用前一交易日（CST） (type: int; required: N). - symbol: WIND 合约全码如 A2605.DCE；大小写不敏感；不传或空表示该日全部 (type: string; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -6036,30 +5345,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

china_futures_lists

- -- 接口名称：中国期货列表 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/futures/futures-lists` -- 参数：`trade_date` -- 原始接口：`get_china_futures_lists_handler` -- 来源文档：`中国期货列表.md` +

consumer_fiscal_revenue_monthly

-
-方法文档注释 +- 接口名称：财政收入 +- HTTP：`GET` +- Path：`api/v1/market/data/economic/china-fiscal-revenue` +- 参数：- +- 来源文档：`财政收入.md` +- 原始接口：`consumer_fiscal_revenue_monthly` ```text -中国期货列表. +财政收入. -Endpoint: ``api/v1/market/data/futures/futures-lists``. +Endpoint: ``api/v1/market/data/economic/china-fiscal-revenue``. Method: ``GET``. -Documented endpoint: ``get_china_futures_lists_handler``. +Documented endpoint: ``consumer_fiscal_revenue_monthly``. Args: - trade_date: 交易日 YYYYMMDD；不传则使用前一交易日（CST） (type: int; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -6071,41 +5373,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

eastmoney_futures_position

- -- 接口名称：东方财富期货持仓 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/eastmoney-futures-position` -- 参数：`exchange`, `variety_code`, `contract_code`, `trade_date`, `start_date`, `end_date`, `member_name_abbr`, `page`, `page_size` -- 原始接口：`get_eastmoney_futures_position` -- 来源文档：`东方财富期货持仓.md` +

consumer_fixed_asset_monthly

-
-方法文档注释 +- 接口名称：固定资产投资 +- HTTP：`GET` +- Path：`api/v1/market/data/economic/china-fixed-asset-investment` +- 参数：- +- 来源文档：`固定资产投资.md` +- 原始接口：`consumer_fixed_asset_monthly` ```text -东方财富期货持仓. +固定资产投资. -Endpoint: ``api/v1/market/data/eastmoney-futures-position``. +Endpoint: ``api/v1/market/data/economic/china-fixed-asset-investment``. Method: ``GET``. -Documented endpoint: ``get_eastmoney_futures_position``. +Documented endpoint: ``consumer_fixed_asset_monthly``. Args: - exchange: 交易所代码：shfe / dce / czce / cffex / ine / gfe (type: string; required: N). - variety_code: 品种代码，如 cu / au / al / IF (type: string; required: N). - contract_code: 合约代码，如 CU2607 / AU2608 (type: string; required: N). - trade_date: 交易日 YYYYMMDD；与 start_date/end_date 互斥 (type: string; required: N). - start_date: 区间起始日 YYYYMMDD；需与 end_date 同时提供 (type: string; required: N). - end_date: 区间结束日 YYYYMMDD；需与 start_date 同时提供 (type: string; required: N). - member_name_abbr: 会员简称 (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -6117,41 +5401,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

eastmoney_futures_strange

- -- 接口名称：东方财富期货持仓 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/eastmoney-futures-position` -- 参数：`exchange`, `variety_code`, `contract_code`, `trade_date`, `start_date`, `end_date`, `member_name_abbr`, `page`, `page_size` -- 原始接口：`get_eastmoney_futures_position` -- 来源文档：`东方财富期货持仓.md` +

consumer_gdp_quarterly

-
-方法文档注释 +- 接口名称：GDP +- HTTP：`GET` +- Path：`api/v1/market/data/economic/china-gdp` +- 参数：- +- 来源文档：`GDP.md` +- 原始接口：`consumer_gdp_quarterly` ```text -东方财富期货持仓. +GDP. -Endpoint: ``api/v1/market/data/eastmoney-futures-position``. +Endpoint: ``api/v1/market/data/economic/china-gdp``. Method: ``GET``. -Documented endpoint: ``get_eastmoney_futures_position``. +Documented endpoint: ``consumer_gdp_quarterly``. Args: - exchange: 交易所代码：shfe / dce / czce / cffex / ine / gfe (type: string; required: N). - variety_code: 品种代码，如 cu / au / al / IF (type: string; required: N). - contract_code: 合约代码，如 CU2607 / AU2608 (type: string; required: N). - trade_date: 交易日 YYYYMMDD；与 start_date/end_date 互斥 (type: string; required: N). - start_date: 区间起始日 YYYYMMDD；需与 end_date 同时提供 (type: string; required: N). - end_date: 区间结束日 YYYYMMDD；需与 start_date 同时提供 (type: string; required: N). - member_name_abbr: 会员简称 (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -6163,34 +5429,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

consumer_industrial_added_value_monthly

-

futures_contract_kline

- -- 接口名称：期货合约K线 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/futures/kline` -- 参数：`symbol`, `interval`, `start`, `end`, `limit` -- 原始接口：`futures_contract_kline` -- 来源文档：`期货合约K线.md` - -
-方法文档注释 +- 接口名称：工业增加值 +- HTTP：`GET` +- Path：`api/v1/market/data/economic/china-industrial-added-value` +- 参数：- +- 来源文档：`工业增加值.md` +- 原始接口：`consumer_industrial_added_value_monthly` ```text -期货合约K线. +工业增加值. -Endpoint: ``api/v1/market/data/futures/kline``. +Endpoint: ``api/v1/market/data/economic/china-industrial-added-value``. Method: ``GET``. -Documented endpoint: ``futures_contract_kline``. +Documented endpoint: ``consumer_industrial_added_value_monthly``. -Args: - symbol: WIND 合约全码，如 A2605.DCE (type: string; required: Y). - interval: 周期，默认 1min；可选 1min/5min/15min/30min/60min/daily/weekly/monthly/quarterly/yearly (type: string; required: N). - start: 开始时间戳（毫秒）；与 end 跨度 ≤3 天；仅 start 表示 [start,+∞) (type: int64; required: N). - end: 结束时间戳（毫秒，闭区间）；须与 start 同时传入，禁止只传 end (type: int64; required: N). - limit: 最大返回条数，默认 500 (type: int; required: N). +Args: raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -6202,34 +5457,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

futures_kline

- -- 接口名称：期货合约K线 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/futures/kline` -- 参数：`symbol`, `interval`, `start`, `end`, `limit` -- 原始接口：`futures_contract_kline` -- 来源文档：`期货合约K线.md` +

consumer_money_supply_monthly

-
-方法文档注释 +- 接口名称：货币供应 +- HTTP：`GET` +- Path：`api/v1/market/data/economic/china-money-supply` +- 参数：- +- 来源文档：`货币供应.md` +- 原始接口：`consumer_money_supply_monthly` ```text -期货合约K线. +货币供应. -Endpoint: ``api/v1/market/data/futures/kline``. +Endpoint: ``api/v1/market/data/economic/china-money-supply``. Method: ``GET``. -Documented endpoint: ``futures_contract_kline``. +Documented endpoint: ``consumer_money_supply_monthly``. Args: - symbol: WIND 合约全码，如 A2605.DCE (type: string; required: Y). - interval: 周期，默认 1min；可选 1min/5min/15min/30min/60min/daily/weekly/monthly/quarterly/yearly (type: string; required: N). - start: 开始时间戳（毫秒）；与 end 跨度 ≤3 天；仅 start 表示 [start,+∞) (type: int64; required: N). - end: 结束时间戳（毫秒，闭区间）；须与 start 同时传入，禁止只传 end (type: int64; required: N). - limit: 最大返回条数，默认 500 (type: int; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -6241,38 +5485,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -## 股东持股 - -

stock_float_holders

- -- 接口名称：十大流通股东 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/holder/stock-holder-ften` -- 参数：`stock_code`, `is_last`, `page`, `page_size` -- 原始接口：`stock_float_holders` -- 来源文档：`十大流通股东.md` +

consumer_pmi_monthly

-
-方法文档注释 +- 接口名称：PMI +- HTTP：`GET` +- Path：`api/v1/market/data/economic/china-pmi` +- 参数：- +- 来源文档：`PMI.md` +- 原始接口：`consumer_pmi_monthly` ```text -十大流通股东. +PMI. -Endpoint: ``api/v1/market/data/holder/stock-holder-ften``. +Endpoint: ``api/v1/market/data/economic/china-pmi``. Method: ``GET``. -Documented endpoint: ``stock_float_holders``. +Documented endpoint: ``consumer_pmi_monthly``. Args: - stock_code: 标的代码，指定时返回该标的全部历史数据 (type: string; required: N). - is_last: 是否取所有标的最新一期，true 时按 page/page_size 分页 (type: bool; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -6284,35 +5513,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_ggcg_em

- -- 接口名称：东方财富股东增减持 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/holder/stock-ggcg-em` -- 参数：`symbol`, `page`, `page_size` -- 原始接口：`stock_ggcg_em_handler` -- 来源文档：`东方财富股东增减持.md` +

consumer_ppi_monthly

-
-方法文档注释 +- 接口名称：PPI +- HTTP：`GET` +- Path：`api/v1/market/data/economic/china-ppi` +- 参数：- +- 来源文档：`PPI.md` +- 原始接口：`consumer_ppi_monthly` ```text -东方财富股东增减持. +PPI. -Endpoint: ``api/v1/market/data/holder/stock-ggcg-em``. +Endpoint: ``api/v1/market/data/economic/china-ppi``. Method: ``GET``. -Documented endpoint: ``stock_ggcg_em_handler``. +Documented endpoint: ``consumer_ppi_monthly``. Args: - symbol: 数据类型：全部 / 股东增持 / 股东减持，默认全部 (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -6324,38 +5541,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_ggmx

- -- 接口名称：董监高持股变动 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/holder/stock-ggmx` -- 参数：`stock_code`, `change_direction`, `start_date`, `end_date`, `page`, `page_size` -- 原始接口：`stock_ggmx_handler` -- 来源文档：`董监高持股变动.md` +

consumer_price_index_monthly

-
-方法文档注释 +- 接口名称：CPI +- HTTP：`GET` +- Path：`api/v1/market/data/economic/china-cpi` +- 参数：- +- 来源文档：`CPI.md` +- 原始接口：`consumer_price_index_monthly` ```text -董监高持股变动. +CPI. -Endpoint: ``api/v1/market/data/holder/stock-ggmx``. +Endpoint: ``api/v1/market/data/economic/china-cpi``. Method: ``GET``. -Documented endpoint: ``stock_ggmx_handler``. +Documented endpoint: ``consumer_price_index_monthly``. Args: - stock_code: 股票代码（如 600001），别名 stockCode (type: string; required: N). - change_direction: 变动方向：增持 / 减持，别名 changeDirection (type: string; required: N). - start_date: 变动日期起始 YYYY-MM-DD，别名 startDate (type: string; required: N). - end_date: 变动日期截止 YYYY-MM-DD，别名 endDate (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -6367,35 +5569,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_ggmx_buy_ranking

- -- 接口名称：董监高增持排名 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/holder/stock-ggmx-buy-ranking` -- 参数：`time_range`, `page`, `page_size` -- 原始接口：`stock_ggmx_buy_ranking_handler` -- 来源文档：`董监高增持排名.md` +

consumer_retail_sales_monthly

-
-方法文档注释 +- 接口名称：社零 +- HTTP：`GET` +- Path：`api/v1/market/data/economic/china-retail-sales` +- 参数：- +- 来源文档：`社零.md` +- 原始接口：`consumer_retail_sales_monthly` ```text -董监高增持排名. +社零. -Endpoint: ``api/v1/market/data/holder/stock-ggmx-buy-ranking``. +Endpoint: ``api/v1/market/data/economic/china-retail-sales``. Method: ``GET``. -Documented endpoint: ``stock_ggmx_buy_ranking_handler``. +Documented endpoint: ``consumer_retail_sales_monthly``. Args: - time_range: 时间范围：1m / 3m / 6m / 1y / 2y，默认 1m，别名 timeRange (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -6407,35 +5597,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_ggmx_sell_ranking

- -- 接口名称：董监高减持排名 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/holder/stock-ggmx-sell-ranking` -- 参数：`time_range`, `page`, `page_size` -- 原始接口：`stock_ggmx_sell_ranking_handler` -- 来源文档：`董监高减持排名.md` +

lpr_monthly

-
-方法文档注释 +- 接口名称：LPR +- HTTP：`GET` +- Path：`api/v1/market/data/economic/china-lpr` +- 参数：- +- 来源文档：`LPR.md` +- 原始接口：`lpr_monthly` ```text -董监高减持排名. +LPR. -Endpoint: ``api/v1/market/data/holder/stock-ggmx-sell-ranking``. +Endpoint: ``api/v1/market/data/economic/china-lpr``. Method: ``GET``. -Documented endpoint: ``stock_ggmx_sell_ranking_handler``. +Documented endpoint: ``lpr_monthly``. Args: - time_range: 时间范围：1m / 3m / 6m / 1y / 2y，默认 1m，别名 timeRange (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -6447,36 +5625,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_holders

- -- 接口名称：十大股东 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/holder/stock-holder-ten` -- 参数：`stock_code`, `is_last`, `page`, `page_size` -- 原始接口：`stock_holders` -- 来源文档：`十大股东.md` +

reserve_ratio_monthly

-
-方法文档注释 +- 接口名称：存款准备金率 +- HTTP：`GET` +- Path：`api/v1/market/data/economic/china-reserve-ratio` +- 参数：- +- 来源文档：`存款准备金率.md` +- 原始接口：`reserve_ratio_monthly` ```text -十大股东. +存款准备金率. -Endpoint: ``api/v1/market/data/holder/stock-holder-ten``. +Endpoint: ``api/v1/market/data/economic/china-reserve-ratio``. Method: ``GET``. -Documented endpoint: ``stock_holders``. +Documented endpoint: ``reserve_ratio_monthly``. Args: - stock_code: 标的代码，指定时返回该标的全部历史数据 (type: string; required: N). - is_last: 是否取所有标的最新一期，true 时按 page/page_size 分页 (type: bool; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -6488,36 +5653,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_holders_number

- -- 接口名称：股东人数 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/holder/stock-holder-nums` -- 参数：`stock_code`, `is_last`, `page`, `page_size` -- 原始接口：`stock_holders_number` -- 来源文档：`股东人数.md` +

tax_revenue_monthly

-
-方法文档注释 +- 接口名称：税收 +- HTTP：`GET` +- Path：`api/v1/market/data/economic/china-tax-revenue` +- 参数：- +- 来源文档：`税收.md` +- 原始接口：`tax_revenue_monthly` ```text -股东人数. +税收. -Endpoint: ``api/v1/market/data/holder/stock-holder-nums``. +Endpoint: ``api/v1/market/data/economic/china-tax-revenue``. Method: ``GET``. -Documented endpoint: ``stock_holders_number``. +Documented endpoint: ``tax_revenue_monthly``. Args: - stock_code: 标的代码，指定时返回该标的全部历史数据 (type: string; required: N). - is_last: 是否取所有标的最新一期，true 时按 page/page_size 分页 (type: bool; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -6529,36 +5681,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_share_chg

+

us_economic

-- 接口名称：股东增减持 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/holder/stock-share-chg` -- 参数：`stock_code`, `is_last`, `page`, `page_size` -- 原始接口：`stock_share_chg` -- 来源文档：`股东增减持.md` - -
-方法文档注释 +- 接口名称：美国经济指标 +- HTTP：`GET` +- Path：`api/v1/market/data/economic/us-economic` +- 参数：`type` +- 来源文档：`美国经济指标.md` +- 原始接口：`us_economic` ```text -股东增减持. +美国经济指标. -Endpoint: ``api/v1/market/data/holder/stock-share-chg``. +Endpoint: ``api/v1/market/data/economic/us-economic``. Method: ``GET``. -Documented endpoint: ``stock_share_chg``. +Documented endpoint: ``us_economic``. Args: - stock_code: 标的代码，指定时返回该标的分页历史数据 (type: string; required: N). - is_last: 是否取所有标的最新一期，true 时按 page/page_size 分页 (type: bool; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. + type: 指标类型，枚举值见下表 (type: string; required: Y). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -6570,31 +5710,25 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -## 股权质押 - -

pledge_summary

- -- 接口名称：股权质押汇总 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/pledge/pledge-summary` -- 参数：`page`, `page_size` -- 原始接口：`stock_pledge_summary` -- 来源文档：`股权质押汇总.md` +

wallstreetcn_financial_calendar

-
-方法文档注释 +- 接口名称：华尔街见闻财经日历 +- HTTP：`GET` +- Path：`api/v1/market/data/finance/financial-calendar/wallstreetcn` +- 参数：`start_date`, `end_date`, `page`, `page_size` +- 来源文档：`华尔街见闻财经日历.md` +- 原始接口：`wallstreetcn_financial_calendar` ```text -股权质押汇总. +华尔街见闻财经日历. -Endpoint: ``api/v1/market/data/pledge/pledge-summary``. +Endpoint: ``api/v1/market/data/finance/financial-calendar/wallstreetcn``. Method: ``GET``. -Documented endpoint: ``stock_pledge_summary``. +Documented endpoint: ``wallstreetcn_financial_calendar``. Args: + start_date: 起始日期 (type: string; required: Y). + end_date: 结束日期（与 start_date 间隔 ≤ 3 天） (type: string; required: Y). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -6611,36 +5745,30 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+### 大模型语料 -

stock_pledge_detail

- -- 接口名称：股权质押明细 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/pledge/pledge-detail` -- 参数：`stock_code`, `is_last`, `page`, `page_size` -- 原始接口：`stock_pledge_detail` -- 来源文档：`股权质押明细.md` +

semantic_search_news

-
-方法文档注释 +- 接口名称：新闻语义搜索 +- HTTP：`GET` +- Path：`api/v1/market/data/semantic-search-news` +- 参数：`query`, `limit`, `year`, `start_time`, `end_time` +- 来源文档：`新闻语义搜索.md` +- 原始接口：`semantic_search_news_handler` ```text -股权质押明细. +新闻语义搜索. -Endpoint: ``api/v1/market/data/pledge/pledge-detail``. +Endpoint: ``api/v1/market/data/semantic-search-news``. Method: ``GET``. -Documented endpoint: ``stock_pledge_detail``. +Documented endpoint: ``semantic_search_news_handler``. Args: - stock_code: 股票代码（symbol.suffix 格式或纯代码）；不传时需配合 `is_last=true` (type: string; required: N). - is_last: 是否仅获取最新一期（无 `stock_code` 时必填为 true） (type: bool; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. + query: 搜索文字 (type: string; required: Y). + limit: 返回条数，默认由服务端决定 (type: int; required: N). + year: 年份，限定搜索范围 (type: int; required: N). + start_time: 起始时间（带时区），与 end_time 同传时区间不超过 3 天 (type: datetime; required: N). + end_time: 结束时间（带时区），与 start_time 同传时区间不超过 3 天 (type: datetime; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -6652,27 +5780,21 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

stock_pledge_summary

+

shareholders_meeting

-- 接口名称：股权质押汇总 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/pledge/pledge-summary` +- 接口名称：股东大会 +- HTTP：`GET` +- Path：`api/v1/market/data/corporate/meeting` - 参数：`page`, `page_size` -- 原始接口：`stock_pledge_summary` -- 来源文档：`股权质押汇总.md` - -
-方法文档注释 +- 来源文档：`股东大会.md` +- 原始接口：`shareholders_meeting` ```text -股权质押汇总. +股东大会. -Endpoint: ``api/v1/market/data/pledge/pledge-summary``. +Endpoint: ``api/v1/market/data/corporate/meeting``. Method: ``GET``. -Documented endpoint: ``stock_pledge_summary``. +Documented endpoint: ``shareholders_meeting``. Args: page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. @@ -6691,33 +5813,32 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -## 公司治理 - -

major_contract

- -- 接口名称：重大合同 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/corporate/contract` -- 参数：`start_date`, `end_date` -- 原始接口：`major_contract` -- 来源文档：`重大合同.md` +

stock_announcements

-
-方法文档注释 +- 接口名称：公告列表 +- HTTP：`GET` +- Path：`api/v1/market/data/announcements/stock-announcements` +- 参数：`stock_code`, `start_date`, `end_date`, `type`, `page`, `page_size` +- 来源文档：`公告列表.md` +- 原始接口：`stock_announcements` ```text -重大合同. +公告列表. -Endpoint: ``api/v1/market/data/corporate/contract``. +Endpoint: ``api/v1/market/data/announcements/stock-announcements``. Method: ``GET``. -Documented endpoint: ``major_contract``. +Documented endpoint: ``stock_announcements``. Args: - start_date: 起始日期（YYYYMMDD），区间跨度 ≤ 3 天 (type: string; required: Y). - end_date: 结束日期（YYYYMMDD），区间跨度 ≤ 3 天 (type: string; required: Y). + stock_code: 证券代码（按标的查询时必填） (type: string; required: N). + start_date: 开始日期 YYYYMMDD（按日期范围查询时必填） (type: string; required: N). + end_date: 结束日期 YYYYMMDD，不填默认当前时间 (type: string; required: N). + type: 查询类型，当前只支持 `stock` (type: string; required: Y). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -6729,30 +5850,27 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

major_contract_by_symbol

- -- 接口名称：重大合同按标的 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/corporate/contract/by-symbol` -- 参数：`symbol`, `page`, `page_size` -- 原始接口：`major_contract_by_symbol` -- 来源文档：`重大合同按标的.md` +

stock_reports

-
-方法文档注释 +- 接口名称：研报列表 +- HTTP：`GET` +- Path：`api/v1/market/data/report/stock-reports` +- 参数：`stock_code`, `start_date`, `end_date`, `type`, `page`, `page_size` +- 来源文档：`研报列表.md` +- 原始接口：`stock_reports` ```text -重大合同按标的. +研报列表. -Endpoint: ``api/v1/market/data/corporate/contract/by-symbol``. +Endpoint: ``api/v1/market/data/report/stock-reports``. Method: ``GET``. -Documented endpoint: ``major_contract_by_symbol``. +Documented endpoint: ``stock_reports``. Args: - symbol: 证券代码（标的） (type: string; required: Y). + stock_code: 证券代码（按标的查询时必填） (type: string; required: N). + start_date: 开始日期 YYYYMMDD（按日期范围查询时必填） (type: string; required: N). + end_date: 结束日期 YYYYMMDD，不填默认当前时间 (type: string; required: N). + type: 查询类型，当前只支持 `stock` (type: string; required: Y). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -6769,29 +5887,26 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+

type_reports

-

major_contract_summary

- -- 接口名称：重大合同汇总 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/corporate/contract/summary` -- 参数：`page`, `page_size` -- 原始接口：`major_contract_summary` -- 来源文档：`重大合同汇总.md` - -
-方法文档注释 +- 接口名称：研报分类 +- HTTP：`GET` +- Path：`api/v1/market/data/report/type-reports` +- 参数：`rept_type`, `start_date`, `end_date`, `page`, `page_size` +- 来源文档：`研报分类.md` +- 原始接口：`type_reports` ```text -重大合同汇总. +研报分类. -Endpoint: ``api/v1/market/data/corporate/contract/summary``. +Endpoint: ``api/v1/market/data/report/type-reports``. Method: ``GET``. -Documented endpoint: ``major_contract_summary``. +Documented endpoint: ``type_reports``. Args: + rept_type: 研报类型：MacroReport / IndustryReport / BrokerMorningReport / StrategyReport / NewStockReport (type: string; required: Y). + start_date: 开始日期 YYYYMMDD (type: string; required: Y). + end_date: 结束日期 YYYYMMDD，不填默认与 `start_date` 相同 (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -6808,29 +5923,28 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

shareholders_meeting

+### 现货数据 -- 接口名称：股东大会 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/corporate/meeting` -- 参数：`page`, `page_size` -- 原始接口：`shareholders_meeting` -- 来源文档：`股东大会.md` +

bullion_price

-
-方法文档注释 +- 接口名称：贵金属价格 +- HTTP：`GET` +- Path：`api/v1/market/data/bullion/price` +- 参数：`symbol`, `start_date`, `end_date`, `page`, `page_size` +- 来源文档：`贵金属价格.md` +- 原始接口：`get_bullion_price` ```text -股东大会. +贵金属价格. -Endpoint: ``api/v1/market/data/corporate/meeting``. +Endpoint: ``api/v1/market/data/bullion/price``. Method: ``GET``. -Documented endpoint: ``shareholders_meeting``. +Documented endpoint: ``get_bullion_price``. Args: + symbol: 标的代码，如 XAUUSD、AU9999 (type: string; required: Y). + start_date: 查询起始日期 YYYYMMDD (type: int; required: Y). + end_date: 查询结束日期 YYYYMMDD；与 start_date 跨度 ≤3 天 (type: int; required: Y). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -6847,37 +5961,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -## 商誉 - -

goodwill_industry

- -- 接口名称：商誉行业 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/goodwill/industry` -- 参数：`date`, `page`, `page_size` -- 原始接口：`goodwill_industry` -- 来源文档：`商誉行业.md` +

bullion_support_symbol

-
-方法文档注释 +- 接口名称：贵金属支持标的 +- HTTP：`GET` +- Path：`api/v1/market/data/bullion/support-symbol` +- 参数：- +- 来源文档：`贵金属支持标的.md` +- 原始接口：`get_bullion_support_symbol` ```text -商誉行业. +贵金属支持标的. -Endpoint: ``api/v1/market/data/goodwill/industry``. +Endpoint: ``api/v1/market/data/bullion/support-symbol``. Method: ``GET``. -Documented endpoint: ``goodwill_industry``. +Documented endpoint: ``get_bullion_support_symbol``. Args: - date: 报告期，如 20250331 (type: string; required: Y). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -6889,27 +5989,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
+### 外汇数据 -

goodwill_market_overview

+

consumer_forex_gold_monthly

-- 接口名称：商誉市场总览 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/goodwill/market-overview` +- 接口名称：外汇黄金 +- HTTP：`GET` +- Path：`api/v1/market/data/economic/china-forex-gold` - 参数：- -- 原始接口：`goodwill_market_overview` -- 来源文档：`商誉市场总览.md` - -
-方法文档注释 +- 来源文档：`外汇黄金.md` +- 原始接口：`consumer_forex_gold_monthly` ```text -商誉市场总览. +外汇黄金. -Endpoint: ``api/v1/market/data/goodwill/market-overview``. +Endpoint: ``api/v1/market/data/economic/china-forex-gold``. Method: ``GET``. -Documented endpoint: ``goodwill_market_overview``. +Documented endpoint: ``consumer_forex_gold_monthly``. Args: raw: Return the decoded JSON payload without tabular extraction. @@ -6923,30 +6019,25 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

goodwill_predict

+### 未发布 -- 接口名称：商誉预测 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/goodwill/predict` -- 参数：`date`, `page`, `page_size` -- 原始接口：`goodwill_predict` -- 来源文档：`商誉预测.md` +

stock_dividends_paginated

-
-方法文档注释 +- 接口名称：股票分红记录分页 +- HTTP：`GET` +- Path：`api/v1/market/data/dividends` +- 参数：`page`, `page_size` +- 来源文档：`股票分红记录分页.md` +- 原始接口：`stock_dividends_paginated` ```text -商誉预测. +股票分红记录分页. -Endpoint: ``api/v1/market/data/goodwill/predict``. +Endpoint: ``api/v1/market/data/dividends``. Method: ``GET``. -Documented endpoint: ``goodwill_predict``. +Documented endpoint: ``stock_dividends_paginated``. Args: - date: 报告期，如 20250331 (type: string; required: Y). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -6963,35 +6054,24 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

goodwill_stock_detail

- -- 接口名称：商誉个股明细 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/goodwill/stock-detail` -- 参数：`date`, `page`, `page_size` -- 原始接口：`goodwill_stock_detail` -- 来源文档：`商誉个股明细.md` +

stock_intraday

-
-方法文档注释 +- 接口名称：股票日内分时 +- HTTP：`GET` +- Path：`api/v1/market/security/{symbol}/intraday` +- 参数：`symbol` +- 来源文档：`股票日内分时.md` +- 原始接口：`stock_intraday` ```text -商誉个股明细. +股票日内分时. -Endpoint: ``api/v1/market/data/goodwill/stock-detail``. +Endpoint: ``api/v1/market/security/{symbol}/intraday``. Method: ``GET``. -Documented endpoint: ``goodwill_stock_detail``. +Documented endpoint: ``stock_intraday``. Args: - date: 报告期，如 20250331 (type: string; required: Y). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. + symbol: 标的代码 (type: SymbolKey; required: Y). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -7003,30 +6083,23 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -

goodwill_stock_impairment

- -- 接口名称：商誉减值 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/goodwill/stock-impairment` -- 参数：`date`, `page`, `page_size` -- 原始接口：`goodwill_stock_impairment` -- 来源文档：`商誉减值.md` +

stock_ipos_paginated

-
-方法文档注释 +- 接口名称：股票IPO分页 +- HTTP：`GET` +- Path：`api/v1/market/data/stock-ipos` +- 参数：`page`, `page_size` +- 来源文档：`股票IPO分页.md` +- 原始接口：`stock_ipos_paginated` ```text -商誉减值. +股票IPO分页. -Endpoint: ``api/v1/market/data/goodwill/stock-impairment``. +Endpoint: ``api/v1/market/data/stock-ipos``. Method: ``GET``. -Documented endpoint: ``goodwill_stock_impairment``. +Documented endpoint: ``stock_ipos_paginated``. Args: - date: 报告期，如 20250331 (type: string; required: Y). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -7043,34 +6116,25 @@ Returns: payloads when multi-page fetching is used with ``raw=True``. ``` -
- -## 全球指数 + -

global_index_daily_kline

- -- 接口名称：全球指数日K线 -- 状态：可调用 -- HTTP 方法：`GET` -- Path：`api/v1/market/data/global-index/daily-kline` -- 参数：`secid`, `start_date`, `end_date` -- 原始接口：`global_index_daily_kline` -- 来源文档：`全球指数日K线.md` - -
-方法文档注释 +- 接口名称：相关股票 +- HTTP：`GET` +- Path：`api/v1/market/security/{symbol}/related` +- 参数：`symbol`, `limit` +- 来源文档：`相关股票.md` +- 原始接口：`stock_related` ```text -全球指数日K线. +相关股票. -Endpoint: ``api/v1/market/data/global-index/daily-kline``. +Endpoint: ``api/v1/market/security/{symbol}/related``. Method: ``GET``. -Documented endpoint: ``global_index_daily_kline``. +Documented endpoint: ``stock_related``. Args: - secid: 东方财富全球指数编码，如 100.NDX、100.DJIA、100.SPX、100.HSI、100.N225 (type: string; required: Y). - start_date: 开始日期 YYYY-MM-DD（含） (type: string; required: N). - end_date: 结束日期 YYYY-MM-DD（含） (type: string; required: N). + symbol: 标的代码 (type: SymbolKey; required: Y). + limit: 返回数量上限，服务端默认 3 (type: int; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -7081,5 +6145,3 @@ Returns: ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page payloads when multi-page fetching is used with ``raw=True``. ``` - -
diff --git a/pyproject.toml b/pyproject.toml index f7ba800..d971759 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "hatchling.build" [project] name = "ftshare" -version = "0.1.0" +version = "0.1.1" description = "Python SDK for FTShare market data APIs." readme = "README.md" requires-python = ">=3.9" diff --git a/src/ftshare/__init__.py b/src/ftshare/__init__.py index f42ea67..efde0ad 100644 --- a/src/ftshare/__init__.py +++ b/src/ftshare/__init__.py @@ -43,8 +43,8 @@ def set_base_url(url: str) -> str: """Set the package-level base URL used by new clients. Args: - url: API base URL. Both ``https://host/data`` and - ``https://host/data/`` are accepted. + url: API base URL. Both ``https://host/gateway`` and + ``https://host/gateway/`` are accepted. Returns: The normalized base URL. diff --git a/src/ftshare/apis/__init__.py b/src/ftshare/apis/__init__.py index 62e3994..838e19c 100644 --- a/src/ftshare/apis/__init__.py +++ b/src/ftshare/apis/__init__.py @@ -1,33 +1,31 @@ -"""Business-domain API mixins used by ``FtshareClient``.""" +"""ftshare-doc topic API mixins used by ``FtshareClient``.""" -from .corporate import CorporateApiMixin -from .economic import EconomicApiMixin +from .stock import StockApiMixin +from .hk import HkApiMixin +from .us import UsApiMixin +from .index import IndexApiMixin from .etf import EtfApiMixin -from .finance import FinanceApiMixin from .fund import FundApiMixin from .futures import FuturesApiMixin -from .global_index import GlobalIndexApiMixin -from .goodwill import GoodwillApiMixin -from .hk import HkApiMixin -from .holder import HolderApiMixin -from .index import IndexApiMixin -from .market import MarketApiMixin -from .pledge import PledgeApiMixin -from .stock import StockApiMixin +from .bond import BondApiMixin +from .economic import EconomicApiMixin +from .llm_corpus import LlmCorpusApiMixin +from .spot import SpotApiMixin +from .forex import ForexApiMixin +from .unpublished import UnpublishedApiMixin __all__ = [ - 'CorporateApiMixin', - 'EconomicApiMixin', + 'StockApiMixin', + 'HkApiMixin', + 'UsApiMixin', + 'IndexApiMixin', 'EtfApiMixin', - 'FinanceApiMixin', 'FundApiMixin', 'FuturesApiMixin', - 'GlobalIndexApiMixin', - 'GoodwillApiMixin', - 'HkApiMixin', - 'HolderApiMixin', - 'IndexApiMixin', - 'MarketApiMixin', - 'PledgeApiMixin', - 'StockApiMixin', + 'BondApiMixin', + 'EconomicApiMixin', + 'LlmCorpusApiMixin', + 'SpotApiMixin', + 'ForexApiMixin', + 'UnpublishedApiMixin', ] diff --git a/src/ftshare/apis/bond.py b/src/ftshare/apis/bond.py new file mode 100644 index 0000000..ce485bf --- /dev/null +++ b/src/ftshare/apis/bond.py @@ -0,0 +1,84 @@ +"""Bond API methods grouped by ftshare-doc.""" + +from __future__ import annotations + +from collections.abc import Sequence +from typing import Any + +from ..endpoints import ENDPOINTS + + +class BondApiMixin: + """Endpoint methods for the bond ftshare-doc topic.""" + + def cb_base_data( + self, + symbol_code: Any | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """可转债基础数据. + + Endpoint: ``api/v1/market/data/cb/cb-base-data``. + Method: ``GET``. + Documented endpoint: ``get_cb_base_data_handler``. + + Args: + symbol_code: 转债代码 (type: string; required: Y). + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'symbol_code': symbol_code} + request_params.update(kwargs) + return self._call_endpoint( + 'cb_base_data', + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def cb_lists( + self, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """可转债列表. + + Endpoint: ``api/v1/market/data/cb/cb-lists``. + Method: ``GET``. + Documented endpoint: ``get_cb_lists_handler``. + + Args: + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {} + request_params.update(kwargs) + return self._call_endpoint( + 'cb_lists', + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) diff --git a/src/ftshare/apis/economic.py b/src/ftshare/apis/economic.py index 40db87f..257626d 100644 --- a/src/ftshare/apis/economic.py +++ b/src/ftshare/apis/economic.py @@ -1,4 +1,4 @@ -"""FTShare economic endpoint methods for FTShare market data.""" +"""Economic API methods grouped by ftshare-doc.""" from __future__ import annotations @@ -9,7 +9,7 @@ class EconomicApiMixin: - """Endpoint methods for the economic API group.""" + """Endpoint methods for the economic ftshare-doc topic.""" def consumer_credit_monthly( self, @@ -151,41 +151,6 @@ def consumer_fixed_asset_monthly( **request_params, ) - def consumer_forex_gold_monthly( - self, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """外汇黄金. - - Endpoint: ``api/v1/market/data/economic/china-forex-gold``. - Method: ``GET``. - Documented endpoint: ``consumer_forex_gold_monthly``. - - Args: - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {} - request_params.update(kwargs) - return self._call_endpoint( - 'consumer_forex_gold_monthly', - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - def consumer_gdp_quarterly( self, *, @@ -573,3 +538,114 @@ def us_economic( **request_params, ) + def baidu_financial_calendar( + self, + start_date: Any | None = None, + end_date: Any | None = None, + category: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """百度财经日历. + + Endpoint: ``api/v1/market/data/finance/financial-calendar/baidu``. + Method: ``GET``. + Documented endpoint: ``baidu_financial_calendar``. + + Args: + start_date: 起始日期 (type: string; required: Y). + end_date: 结束日期（与 start_date 间隔 ≤ 3 天） (type: string; required: Y). + category: 筛选大类：`economic` / `ipo` / `report_time` / `trade_reminder`；不传返回全部 (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'start_date': start_date, 'end_date': end_date, 'category': category} + request_params.update(kwargs) + path = ENDPOINTS['baidu_financial_calendar'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def wallstreetcn_financial_calendar( + self, + start_date: Any | None = None, + end_date: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """华尔街见闻财经日历. + + Endpoint: ``api/v1/market/data/finance/financial-calendar/wallstreetcn``. + Method: ``GET``. + Documented endpoint: ``wallstreetcn_financial_calendar``. + + Args: + start_date: 起始日期 (type: string; required: Y). + end_date: 结束日期（与 start_date 间隔 ≤ 3 天） (type: string; required: Y). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'start_date': start_date, 'end_date': end_date} + request_params.update(kwargs) + path = ENDPOINTS['wallstreetcn_financial_calendar'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) diff --git a/src/ftshare/apis/etf.py b/src/ftshare/apis/etf.py index 4db3e31..74ebaaf 100644 --- a/src/ftshare/apis/etf.py +++ b/src/ftshare/apis/etf.py @@ -1,4 +1,4 @@ -"""FTShare etf endpoint methods for FTShare market data.""" +"""ETF API methods grouped by ftshare-doc.""" from __future__ import annotations @@ -9,7 +9,7 @@ class EtfApiMixin: - """Endpoint methods for the etf API group.""" + """Endpoint methods for the etf ftshare-doc topic.""" def etf_adjust_factor( self, @@ -347,4 +347,3 @@ def etf_pre_single( as_dataframe=as_dataframe, **request_params, ) - diff --git a/src/ftshare/apis/finance.py b/src/ftshare/apis/finance.py deleted file mode 100644 index e818896..0000000 --- a/src/ftshare/apis/finance.py +++ /dev/null @@ -1,450 +0,0 @@ -"""FTShare finance endpoint methods for FTShare market data.""" - -from __future__ import annotations - -from collections.abc import Sequence -from typing import Any - -from ..endpoints import ENDPOINTS - - -class FinanceApiMixin: - """Endpoint methods for the finance API group.""" - - def baidu_financial_calendar( - self, - start_date: Any | None = None, - end_date: Any | None = None, - category: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """百度财经日历. - - Endpoint: ``api/v1/market/data/finance/financial-calendar/baidu``. - Method: ``GET``. - Documented endpoint: ``baidu_financial_calendar``. - - Args: - start_date: 起始日期 (type: string; required: Y). - end_date: 结束日期（与 start_date 间隔 ≤ 3 天） (type: string; required: Y). - category: 筛选大类：`economic` / `ipo` / `report_time` / `trade_reminder`；不传返回全部 (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'start_date': start_date, 'end_date': end_date, 'category': category} - request_params.update(kwargs) - path = ENDPOINTS['baidu_financial_calendar'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def balance( - self, - stock_code: Any | None = None, - year: Any | None = None, - report_type: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """A股资产负债表. - - Endpoint: ``api/v1/market/data/finance/balance``. - Method: ``GET``. - Documented endpoint: ``balance``. - - Args: - stock_code: A 股代码，6 位数字 + 后缀（如 600519.SH）；存在则进入模式A 单票查询 (type: string; required: N). - year: 年份（模式B 必填），如 2024 (type: int; required: N). - report_type: 报告期类型（模式B 必填）：q1 / q2 / q3 / annual（兼容 h1） (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'stock_code': stock_code, 'year': year, 'report_type': report_type} - request_params.update(kwargs) - path = ENDPOINTS['balance'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - max_page_size=500, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def cashflow( - self, - stock_code: Any | None = None, - year: Any | None = None, - report_type: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """A股现金流量表. - - Endpoint: ``api/v1/market/data/finance/cashflow``. - Method: ``GET``. - Documented endpoint: ``cashflow``. - - Args: - stock_code: A 股代码，6 位数字 + 后缀（如 000001.SZ）；存在则进入模式A 单票查询 (type: string; required: N). - year: 年份（模式B 必填），如 2024 (type: int; required: N). - report_type: 报告期类型（模式B 必填）：q1 / q2 / q3 / annual (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'stock_code': stock_code, 'year': year, 'report_type': report_type} - request_params.update(kwargs) - path = ENDPOINTS['cashflow'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - max_page_size=500, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def cashflow_stock_code( - self, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """现金流支持股票代码. - - Endpoint: ``api/v1/market/data/finance/cashflow-stock-code``. - Method: ``GET``. - Documented endpoint: ``get_cashflow_stock_code``. - - Args: - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {} - request_params.update(kwargs) - return self._call_endpoint( - 'cashflow_stock_code', - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def earnings_reports_paginated( - self, - stock_code: Any | None = None, - year: Any | None = None, - report_type: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """业绩快报. - - Endpoint: ``api/v1/market/data/finance/stock-performance-express``. - Method: ``GET``. - Documented endpoint: ``earnings_reports_paginated``. - - Args: - stock_code: A 股代码（如 000001.SZ）；传则查单票全部业绩快报 (type: string; required: N). - year: 年份（按报告期查询时必填），如 2024 (type: int; required: N). - report_type: 报告类型枚举（按报告期查询时必填）：q1 / q2 / q3 / annual / announcement (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'stock_code': stock_code, 'year': year, 'report_type': report_type} - request_params.update(kwargs) - path = ENDPOINTS['earnings_reports_paginated'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - max_page_size=500, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def income( - self, - stock_code: Any | None = None, - year: Any | None = None, - report_type: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """A股利润表. - - Endpoint: ``api/v1/market/data/finance/income``. - Method: ``GET``. - Documented endpoint: ``income``. - - Args: - stock_code: A 股代码，6 位数字 + 后缀（如 000001.SZ）；存在则进入模式A 单票查询 (type: string; required: N). - year: 年份（模式B 必填），如 2024 (type: int; required: N). - report_type: 报告期类型（模式B 必填）：q1 / q2 / q3 / annual（兼容 h1） (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'stock_code': stock_code, 'year': year, 'report_type': report_type} - request_params.update(kwargs) - path = ENDPOINTS['income'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - max_page_size=500, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def performance_forecasts_paginated( - self, - stock_code: Any | None = None, - year: Any | None = None, - report_type: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """业绩预告. - - Endpoint: ``api/v1/market/data/finance/stock-performance-forecast``. - Method: ``GET``. - Documented endpoint: ``performance_forecasts_paginated``. - - Args: - stock_code: A 股代码，6 位数字 + 后缀（如 000001.SZ）；存在则进入模式A 单票查询 (type: string; required: N). - year: 年份（模式B 必填），如 2024 (type: int; required: N). - report_type: 报告期类型（模式B 必填）：q1 / q2 / q3 / annual (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'stock_code': stock_code, 'year': year, 'report_type': report_type} - request_params.update(kwargs) - path = ENDPOINTS['performance_forecasts_paginated'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - max_page_size=500, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def wallstreetcn_financial_calendar( - self, - start_date: Any | None = None, - end_date: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """华尔街见闻财经日历. - - Endpoint: ``api/v1/market/data/finance/financial-calendar/wallstreetcn``. - Method: ``GET``. - Documented endpoint: ``wallstreetcn_financial_calendar``. - - Args: - start_date: 起始日期 (type: string; required: Y). - end_date: 结束日期（与 start_date 间隔 ≤ 3 天） (type: string; required: Y). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'start_date': start_date, 'end_date': end_date} - request_params.update(kwargs) - path = ENDPOINTS['wallstreetcn_financial_calendar'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - diff --git a/src/ftshare/apis/global_index.py b/src/ftshare/apis/forex.py similarity index 57% rename from src/ftshare/apis/global_index.py rename to src/ftshare/apis/forex.py index 44b463b..2a26227 100644 --- a/src/ftshare/apis/global_index.py +++ b/src/ftshare/apis/forex.py @@ -1,4 +1,4 @@ -"""FTShare global_index endpoint methods for FTShare market data.""" +"""Foreign exchange API methods grouped by ftshare-doc.""" from __future__ import annotations @@ -8,30 +8,24 @@ from ..endpoints import ENDPOINTS -class GlobalIndexApiMixin: - """Endpoint methods for the global_index API group.""" +class ForexApiMixin: + """Endpoint methods for the forex ftshare-doc topic.""" - def global_index_daily_kline( + def consumer_forex_gold_monthly( self, - secid: Any | None = None, - start_date: Any | None = None, - end_date: Any | None = None, *, raw: bool = False, fields: Sequence[str] | str | None = None, as_dataframe: bool = True, **kwargs: Any, ) -> Any: - """全球指数日K线. + """外汇黄金. - Endpoint: ``api/v1/market/data/global-index/daily-kline``. + Endpoint: ``api/v1/market/data/economic/china-forex-gold``. Method: ``GET``. - Documented endpoint: ``global_index_daily_kline``. + Documented endpoint: ``consumer_forex_gold_monthly``. Args: - secid: 东方财富全球指数编码，如 100.NDX、100.DJIA、100.SPX、100.HSI、100.N225 (type: string; required: Y). - start_date: 开始日期 YYYY-MM-DD（含） (type: string; required: N). - end_date: 结束日期 YYYY-MM-DD（含） (type: string; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -42,13 +36,12 @@ def global_index_daily_kline( ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page payloads when multi-page fetching is used with ``raw=True``. """ - request_params = {'secid': secid, 'start_date': start_date, 'end_date': end_date} + request_params = {} request_params.update(kwargs) return self._call_endpoint( - 'global_index_daily_kline', + 'consumer_forex_gold_monthly', raw=raw, fields=fields, as_dataframe=as_dataframe, **request_params, ) - diff --git a/src/ftshare/apis/fund.py b/src/ftshare/apis/fund.py index 5eb0f16..752b2e3 100644 --- a/src/ftshare/apis/fund.py +++ b/src/ftshare/apis/fund.py @@ -1,4 +1,4 @@ -"""FTShare fund endpoint methods for FTShare market data.""" +"""Public fund API methods grouped by ftshare-doc.""" from __future__ import annotations @@ -9,7 +9,7 @@ class FundApiMixin: - """Endpoint methods for the fund API group.""" + """Endpoint methods for the fund ftshare-doc topic.""" def fund_basicinfo( self, @@ -257,4 +257,3 @@ def fund_support_symbols( as_dataframe=as_dataframe, **request_params, ) - diff --git a/src/ftshare/apis/futures.py b/src/ftshare/apis/futures.py index 2fbd137..4c86a02 100644 --- a/src/ftshare/apis/futures.py +++ b/src/ftshare/apis/futures.py @@ -1,4 +1,4 @@ -"""FTShare futures endpoint methods for FTShare market data.""" +"""Futures API methods grouped by ftshare-doc.""" from __future__ import annotations @@ -9,7 +9,150 @@ class FuturesApiMixin: - """Endpoint methods for the futures API group.""" + """Endpoint methods for the futures ftshare-doc topic.""" + + def major_contract( + self, + start_date: Any | None = None, + end_date: Any | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """重大合同. + + Endpoint: ``api/v1/market/data/corporate/contract``. + Method: ``GET``. + Documented endpoint: ``major_contract``. + + Args: + start_date: 起始日期（YYYYMMDD），区间跨度 ≤ 3 天 (type: string; required: Y). + end_date: 结束日期（YYYYMMDD），区间跨度 ≤ 3 天 (type: string; required: Y). + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'start_date': start_date, 'end_date': end_date} + request_params.update(kwargs) + return self._call_endpoint( + 'major_contract', + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def major_contract_by_symbol( + self, + symbol: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """重大合同按标的. + + Endpoint: ``api/v1/market/data/corporate/contract/by-symbol``. + Method: ``GET``. + Documented endpoint: ``major_contract_by_symbol``. + + Args: + symbol: 证券代码（标的） (type: string; required: Y). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'symbol': symbol} + request_params.update(kwargs) + path = ENDPOINTS['major_contract_by_symbol'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def major_contract_summary( + self, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """重大合同汇总. + + Endpoint: ``api/v1/market/data/corporate/contract/summary``. + Method: ``GET``. + Documented endpoint: ``major_contract_summary``. + + Args: + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {} + request_params.update(kwargs) + path = ENDPOINTS['major_contract_summary'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) def china_futures_base_data( self, @@ -306,4 +449,3 @@ def futures_kline( as_dataframe=as_dataframe, **request_params, ) - diff --git a/src/ftshare/apis/hk.py b/src/ftshare/apis/hk.py index 631952b..9fbf758 100644 --- a/src/ftshare/apis/hk.py +++ b/src/ftshare/apis/hk.py @@ -1,4 +1,4 @@ -"""FTShare hk endpoint methods for FTShare market data.""" +"""Hong Kong market API methods grouped by ftshare-doc.""" from __future__ import annotations @@ -9,7 +9,7 @@ class HkApiMixin: - """Endpoint methods for the hk API group.""" + """Endpoint methods for the hk ftshare-doc topic.""" def company_hk( self, @@ -688,10 +688,9 @@ def market_cap_hk( **request_params, ) - def stk_ah_comparison( + def eastmoney_hk_index_daily_kline( self, - hk_code: Any | None = None, - ts_code: Any | None = None, + index_code: Any | None = None, trade_date: Any | None = None, start_date: Any | None = None, end_date: Any | None = None, @@ -706,18 +705,17 @@ def stk_ah_comparison( as_dataframe: bool = True, **kwargs: Any, ) -> Any: - """AH股对比. + """东方财富港股指数日K. - Endpoint: ``api/v1/market/data/hk/stk-ah-comparison``. + Endpoint: ``api/v1/market/data/eastmoney-hk-index-daily-kline``. Method: ``GET``. - Documented endpoint: ``get_stk_ah_comparison``. + Documented endpoint: ``get_eastmoney_hk_index_daily_kline``. Args: - hk_code: 港股股票代码，支持 `700` 或 `00700.HK` (type: string; required: N). - ts_code: A 股股票代码，格式 `xxxxxx.SH/SZ/BJ` (type: string; required: N). - trade_date: 交易日期 YYYYMMDD (type: int32; required: N). - start_date: 起始日期 YYYYMMDD (type: int32; required: N). - end_date: 结束日期 YYYYMMDD (type: int32; required: N). + index_code: 指数代码，如 HSI / HSCEI / HSTECH；不传返回全部指数 (type: string; required: N). + trade_date: 交易日 YYYY-MM-DD；与 start_date/end_date 互斥 (type: string; required: N). + start_date: 区间起始日 YYYY-MM-DD；需与 end_date 同时提供 (type: string; required: N). + end_date: 区间结束日 YYYY-MM-DD；需与 start_date 同时提供 (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -733,9 +731,9 @@ def stk_ah_comparison( ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page payloads when multi-page fetching is used with ``raw=True``. """ - request_params = {'hk_code': hk_code, 'ts_code': ts_code, 'trade_date': trade_date, 'start_date': start_date, 'end_date': end_date} + request_params = {'index_code': index_code, 'trade_date': trade_date, 'start_date': start_date, 'end_date': end_date} request_params.update(kwargs) - path = ENDPOINTS['stk_ah_comparison'].path + path = ENDPOINTS['eastmoney_hk_index_daily_kline'].path return self.get_paginated( path, page=page, @@ -743,10 +741,8 @@ def stk_ah_comparison( limit=limit, all_pages=all_pages, max_pages=max_pages, - max_page_size=1000, raw=raw, fields=fields, as_dataframe=as_dataframe, **request_params, ) - diff --git a/src/ftshare/apis/index.py b/src/ftshare/apis/index.py index e9111e0..a5cdf4a 100644 --- a/src/ftshare/apis/index.py +++ b/src/ftshare/apis/index.py @@ -1,4 +1,4 @@ -"""FTShare index endpoint methods for FTShare market data.""" +"""Index API methods grouped by ftshare-doc.""" from __future__ import annotations @@ -9,7 +9,48 @@ class IndexApiMixin: - """Endpoint methods for the index API group.""" + """Endpoint methods for the index ftshare-doc topic.""" + + def global_index_daily_kline( + self, + secid: Any | None = None, + start_date: Any | None = None, + end_date: Any | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """全球指数日K线. + + Endpoint: ``api/v1/market/data/global-index/daily-kline``. + Method: ``GET``. + Documented endpoint: ``global_index_daily_kline``. + + Args: + secid: 东方财富全球指数编码，如 100.NDX、100.DJIA、100.SPX、100.HSI、100.N225 (type: string; required: Y). + start_date: 开始日期 YYYY-MM-DD（含） (type: string; required: N). + end_date: 结束日期 YYYY-MM-DD（含） (type: string; required: N). + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'secid': secid, 'start_date': start_date, 'end_date': end_date} + request_params.update(kwargs) + return self._call_endpoint( + 'global_index_daily_kline', + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) def index_description_list( self, @@ -171,3 +212,188 @@ def index_weight_summary( **request_params, ) + def index_description_all( + self, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """指数基础信息. + + Endpoint: ``api/v1/market/data/index-description-all``. + Method: ``GET``. + Documented endpoint: ``index_description_all``. + + Args: + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {} + request_params.update(kwargs) + return self._call_endpoint( + 'index_description_all', + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def sw_industry_constituent_history( + self, + industry_code: Any | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """申万行业成份股历史. + + Endpoint: ``api/v1/market/data/sw-industry/constituent-history``. + Method: ``GET``. + Documented endpoint: ``sw_industry_constituent_history``. + + Args: + industry_code: 行业代码，带 .SI 后缀，如 801010.SI (type: string; required: Y). + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'industry_code': industry_code} + request_params.update(kwargs) + return self._call_endpoint( + 'sw_industry_constituent_history', + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def sw_industry_daily_metrics( + self, + level: Any | None = None, + start_date: Any | None = None, + end_date: Any | None = None, + industry_code: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """申万行业日度指标. + + Endpoint: ``api/v1/market/data/sw-industry/daily-metrics``. + Method: ``GET``. + Documented endpoint: ``sw_industry_daily_metrics``. + + Args: + level: 行业层级：1/2/3 (type: int; required: Y). + start_date: 起始日期，YYYYMMDD (type: string; required: Y). + end_date: 截止日期，YYYYMMDD (type: string; required: Y). + industry_code: 行业代码，带 .SI 后缀，如 801010.SI (type: string; required: Y). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'level': level, 'start_date': start_date, 'end_date': end_date, 'industry_code': industry_code} + request_params.update(kwargs) + path = ENDPOINTS['sw_industry_daily_metrics'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def sw_industry_overview( + self, + date: Any | None = None, + level: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """申万行业总览. + + Endpoint: ``api/v1/market/data/sw-industry/overview``. + Method: ``GET``. + Documented endpoint: ``sw_industry_overview``. + + Args: + date: 交易日，格式 YYYYMMDD (type: string; required: Y). + level: 行业层级：1/2/3，不传返回全部 (type: int; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'date': date, 'level': level} + request_params.update(kwargs) + path = ENDPOINTS['sw_industry_overview'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) diff --git a/src/ftshare/apis/goodwill.py b/src/ftshare/apis/llm_corpus.py similarity index 69% rename from src/ftshare/apis/goodwill.py rename to src/ftshare/apis/llm_corpus.py index 04101a7..749cd4a 100644 --- a/src/ftshare/apis/goodwill.py +++ b/src/ftshare/apis/llm_corpus.py @@ -1,4 +1,4 @@ -"""FTShare goodwill endpoint methods for FTShare market data.""" +"""LLM corpus API methods grouped by ftshare-doc.""" from __future__ import annotations @@ -8,12 +8,11 @@ from ..endpoints import ENDPOINTS -class GoodwillApiMixin: - """Endpoint methods for the goodwill API group.""" +class LlmCorpusApiMixin: + """Endpoint methods for the llm_corpus ftshare-doc topic.""" - def goodwill_industry( + def shareholders_meeting( self, - date: Any | None = None, page: int | None = None, page_size: int | None = None, limit: int | None = None, @@ -25,14 +24,13 @@ def goodwill_industry( as_dataframe: bool = True, **kwargs: Any, ) -> Any: - """商誉行业. + """股东大会. - Endpoint: ``api/v1/market/data/goodwill/industry``. + Endpoint: ``api/v1/market/data/corporate/meeting``. Method: ``GET``. - Documented endpoint: ``goodwill_industry``. + Documented endpoint: ``shareholders_meeting``. Args: - date: 报告期，如 20250331 (type: string; required: Y). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -48,9 +46,9 @@ def goodwill_industry( ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page payloads when multi-page fetching is used with ``raw=True``. """ - request_params = {'date': date} + request_params = {} request_params.update(kwargs) - path = ENDPOINTS['goodwill_industry'].path + path = ENDPOINTS['shareholders_meeting'].path return self.get_paginated( path, page=page, @@ -64,21 +62,31 @@ def goodwill_industry( **request_params, ) - def goodwill_market_overview( + def semantic_search_news( self, + query: Any | None = None, + limit: Any | None = None, + year: Any | None = None, + start_time: Any | None = None, + end_time: Any | None = None, *, raw: bool = False, fields: Sequence[str] | str | None = None, as_dataframe: bool = True, **kwargs: Any, ) -> Any: - """商誉市场总览. + """新闻语义搜索. - Endpoint: ``api/v1/market/data/goodwill/market-overview``. + Endpoint: ``api/v1/market/data/semantic-search-news``. Method: ``GET``. - Documented endpoint: ``goodwill_market_overview``. + Documented endpoint: ``semantic_search_news_handler``. Args: + query: 搜索文字 (type: string; required: Y). + limit: 返回条数，默认由服务端决定 (type: int; required: N). + year: 年份，限定搜索范围 (type: int; required: N). + start_time: 起始时间（带时区），与 end_time 同传时区间不超过 3 天 (type: datetime; required: N). + end_time: 结束时间（带时区），与 start_time 同传时区间不超过 3 天 (type: datetime; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -89,19 +97,21 @@ def goodwill_market_overview( ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page payloads when multi-page fetching is used with ``raw=True``. """ - request_params = {} + request_params = {'query': query, 'limit': limit, 'year': year, 'start_time': start_time, 'end_time': end_time} request_params.update(kwargs) return self._call_endpoint( - 'goodwill_market_overview', + 'semantic_search_news', raw=raw, fields=fields, as_dataframe=as_dataframe, **request_params, ) - def goodwill_predict( + def type_reports( self, - date: Any | None = None, + rept_type: Any | None = None, + start_date: Any | None = None, + end_date: Any | None = None, page: int | None = None, page_size: int | None = None, limit: int | None = None, @@ -113,14 +123,16 @@ def goodwill_predict( as_dataframe: bool = True, **kwargs: Any, ) -> Any: - """商誉预测. + """研报分类. - Endpoint: ``api/v1/market/data/goodwill/predict``. + Endpoint: ``api/v1/market/data/report/type-reports``. Method: ``GET``. - Documented endpoint: ``goodwill_predict``. + Documented endpoint: ``type_reports``. Args: - date: 报告期，如 20250331 (type: string; required: Y). + rept_type: 研报类型：MacroReport / IndustryReport / BrokerMorningReport / StrategyReport / NewStockReport (type: string; required: Y). + start_date: 开始日期 YYYYMMDD (type: string; required: Y). + end_date: 结束日期 YYYYMMDD，不填默认与 `start_date` 相同 (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -136,9 +148,9 @@ def goodwill_predict( ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page payloads when multi-page fetching is used with ``raw=True``. """ - request_params = {'date': date} + request_params = {'rept_type': rept_type, 'start_date': start_date, 'end_date': end_date} request_params.update(kwargs) - path = ENDPOINTS['goodwill_predict'].path + path = ENDPOINTS['type_reports'].path return self.get_paginated( path, page=page, @@ -152,9 +164,12 @@ def goodwill_predict( **request_params, ) - def goodwill_stock_detail( + def stock_announcements( self, - date: Any | None = None, + stock_code: Any | None = None, + start_date: Any | None = None, + end_date: Any | None = None, + type: Any | None = None, page: int | None = None, page_size: int | None = None, limit: int | None = None, @@ -166,14 +181,17 @@ def goodwill_stock_detail( as_dataframe: bool = True, **kwargs: Any, ) -> Any: - """商誉个股明细. + """公告列表. - Endpoint: ``api/v1/market/data/goodwill/stock-detail``. + Endpoint: ``api/v1/market/data/announcements/stock-announcements``. Method: ``GET``. - Documented endpoint: ``goodwill_stock_detail``. + Documented endpoint: ``stock_announcements``. Args: - date: 报告期，如 20250331 (type: string; required: Y). + stock_code: 证券代码（按标的查询时必填） (type: string; required: N). + start_date: 开始日期 YYYYMMDD（按日期范围查询时必填） (type: string; required: N). + end_date: 结束日期 YYYYMMDD，不填默认当前时间 (type: string; required: N). + type: 查询类型，当前只支持 `stock` (type: string; required: Y). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -189,9 +207,9 @@ def goodwill_stock_detail( ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page payloads when multi-page fetching is used with ``raw=True``. """ - request_params = {'date': date} + request_params = {'stock_code': stock_code, 'start_date': start_date, 'end_date': end_date, 'type': type} request_params.update(kwargs) - path = ENDPOINTS['goodwill_stock_detail'].path + path = ENDPOINTS['stock_announcements'].path return self.get_paginated( path, page=page, @@ -205,9 +223,12 @@ def goodwill_stock_detail( **request_params, ) - def goodwill_stock_impairment( + def stock_reports( self, - date: Any | None = None, + stock_code: Any | None = None, + start_date: Any | None = None, + end_date: Any | None = None, + type: Any | None = None, page: int | None = None, page_size: int | None = None, limit: int | None = None, @@ -219,14 +240,17 @@ def goodwill_stock_impairment( as_dataframe: bool = True, **kwargs: Any, ) -> Any: - """商誉减值. + """研报列表. - Endpoint: ``api/v1/market/data/goodwill/stock-impairment``. + Endpoint: ``api/v1/market/data/report/stock-reports``. Method: ``GET``. - Documented endpoint: ``goodwill_stock_impairment``. + Documented endpoint: ``stock_reports``. Args: - date: 报告期，如 20250331 (type: string; required: Y). + stock_code: 证券代码（按标的查询时必填） (type: string; required: N). + start_date: 开始日期 YYYYMMDD（按日期范围查询时必填） (type: string; required: N). + end_date: 结束日期 YYYYMMDD，不填默认当前时间 (type: string; required: N). + type: 查询类型，当前只支持 `stock` (type: string; required: Y). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -242,9 +266,9 @@ def goodwill_stock_impairment( ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page payloads when multi-page fetching is used with ``raw=True``. """ - request_params = {'date': date} + request_params = {'stock_code': stock_code, 'start_date': start_date, 'end_date': end_date, 'type': type} request_params.update(kwargs) - path = ENDPOINTS['goodwill_stock_impairment'].path + path = ENDPOINTS['stock_reports'].path return self.get_paginated( path, page=page, @@ -257,4 +281,3 @@ def goodwill_stock_impairment( as_dataframe=as_dataframe, **request_params, ) - diff --git a/src/ftshare/apis/market.py b/src/ftshare/apis/market.py deleted file mode 100644 index f2cf6d7..0000000 --- a/src/ftshare/apis/market.py +++ /dev/null @@ -1,2352 +0,0 @@ -"""FTShare market endpoint methods for FTShare market data.""" - -from __future__ import annotations - -from collections.abc import Sequence -from typing import Any - -from ..endpoints import ENDPOINTS - - -class MarketApiMixin: - """Endpoint methods for the market API group.""" - - def auction_results( - self, - ts_code: Any | None = None, - trade_date: Any | None = None, - start_date: Any | None = None, - end_date: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """集合竞价结果. - - Endpoint: ``api/v1/market/data/auction-results``. - Method: ``GET``. - Documented endpoint: ``auction_results``. - - Args: - ts_code: 股票代码，如 000001.XSHE (type: string; required: N). - trade_date: 交易日，格式 YYYYMMDD (type: string; required: N). - start_date: 起始日期，格式 YYYYMMDD (type: string; required: N). - end_date: 结束日期，格式 YYYYMMDD (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'ts_code': ts_code, 'trade_date': trade_date, 'start_date': start_date, 'end_date': end_date} - request_params.update(kwargs) - path = ENDPOINTS['auction_results'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def bse_mapping( - self, - o_code: Any | None = None, - n_code: Any | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """北交所映射. - - Endpoint: ``api/v1/market/data/bse-mapping``. - Method: ``GET``. - Documented endpoint: ``get_bse_mapping``. - - Args: - o_code: 旧代码（如 `838163.BJ`） (type: string; required: N). - n_code: 新代码（如 `920163.BJ`） (type: string; required: N). - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'o_code': o_code, 'n_code': n_code} - request_params.update(kwargs) - return self._call_endpoint( - 'bse_mapping', - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def bullion_price( - self, - symbol: Any | None = None, - start_date: Any | None = None, - end_date: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """贵金属价格. - - Endpoint: ``api/v1/market/data/bullion/price``. - Method: ``GET``. - Documented endpoint: ``get_bullion_price``. - - Args: - symbol: 标的代码，如 XAUUSD、AU9999 (type: string; required: Y). - start_date: 查询起始日期 YYYYMMDD (type: int; required: Y). - end_date: 查询结束日期 YYYYMMDD；与 start_date 跨度 ≤3 天 (type: int; required: Y). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'symbol': symbol, 'start_date': start_date, 'end_date': end_date} - request_params.update(kwargs) - path = ENDPOINTS['bullion_price'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def bullion_support_symbol( - self, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """贵金属支持标的. - - Endpoint: ``api/v1/market/data/bullion/support-symbol``. - Method: ``GET``. - Documented endpoint: ``get_bullion_support_symbol``. - - Args: - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {} - request_params.update(kwargs) - return self._call_endpoint( - 'bullion_support_symbol', - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def cb_base_data( - self, - symbol_code: Any | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """可转债基础数据. - - Endpoint: ``api/v1/market/data/cb/cb-base-data``. - Method: ``GET``. - Documented endpoint: ``get_cb_base_data_handler``. - - Args: - symbol_code: 转债代码 (type: string; required: Y). - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'symbol_code': symbol_code} - request_params.update(kwargs) - return self._call_endpoint( - 'cb_base_data', - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def cb_lists( - self, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """可转债列表. - - Endpoint: ``api/v1/market/data/cb/cb-lists``. - Method: ``GET``. - Documented endpoint: ``get_cb_lists_handler``. - - Args: - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {} - request_params.update(kwargs) - return self._call_endpoint( - 'cb_lists', - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def company_list( - self, - stock_name: Any | None = None, - stock_code: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """公司列表. - - Endpoint: ``api/v1/market/data/company-list``. - Method: ``GET``. - Documented endpoint: ``get_company_list``. - - Args: - stock_name: 股票名称，精确匹配 (type: string; required: N). - stock_code: 股票代码，精确匹配 (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'stock_name': stock_name, 'stock_code': stock_code} - request_params.update(kwargs) - path = ENDPOINTS['company_list'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def eastmoney_board_constituents( - self, - board_code: Any | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """东方财富板块成份股. - - Endpoint: ``api/v1/market/data/eastmoney-board-constituents``. - Method: ``GET``. - Documented endpoint: ``eastmoney_board_constituents``. - - Args: - board_code: 板块代码，如 BK1024 (type: string; required: Y). - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'board_code': board_code} - request_params.update(kwargs) - return self._call_endpoint( - 'eastmoney_board_constituents', - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def eastmoney_board_daily_kline( - self, - board_code: Any | None = None, - start_date: Any | None = None, - end_date: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """东方财富板块日线OHLC. - - Endpoint: ``api/v1/market/data/eastmoney-board-daily-ohlc``. - Method: ``GET``. - Documented endpoint: ``eastmoney_board_daily_kline``. - - Args: - board_code: 板块代码，如 BK1024 (type: string; required: Y). - start_date: 起始日期（含），YYYY-MM-DD 或 YYYYMMDD (type: string; required: N). - end_date: 截止日期（含），YYYY-MM-DD 或 YYYYMMDD (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'board_code': board_code, 'start_date': start_date, 'end_date': end_date} - request_params.update(kwargs) - path = ENDPOINTS['eastmoney_board_daily_kline'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def eastmoney_board_latest_kline( - self, - board_code: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """东方财富板块最新OHLC. - - Endpoint: ``api/v1/market/data/eastmoney-board-latest-ohlc``. - Method: ``GET``. - Documented endpoint: ``eastmoney_board_latest_kline``. - - Args: - board_code: 板块代码，如 BK1024；不传则返回全部板块最新K线 (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'board_code': board_code} - request_params.update(kwargs) - path = ENDPOINTS['eastmoney_board_latest_kline'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def eastmoney_concept_boards( - self, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """东方财富概念板块. - - Endpoint: ``api/v1/market/data/eastmoney-concept-boards``. - Method: ``GET``. - Documented endpoint: ``eastmoney_concept_boards``. - - Args: - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {} - request_params.update(kwargs) - return self._call_endpoint( - 'eastmoney_concept_boards', - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def eastmoney_dapan_flow( - self, - trade_date: Any | None = None, - start_date: Any | None = None, - end_date: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """东方财富大盘资金流. - - Endpoint: ``api/v1/market/data/eastmoney-dapan-flow``. - Method: ``GET``. - Documented endpoint: ``get_eastmoney_dapan_flow``. - - Args: - trade_date: 交易日 YYYYMMDD；与 start_date/end_date 互斥 (type: string; required: N). - start_date: 区间起始日 YYYYMMDD；需与 end_date 同时提供 (type: string; required: N). - end_date: 区间结束日 YYYYMMDD；需与 start_date 同时提供 (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'trade_date': trade_date, 'start_date': start_date, 'end_date': end_date} - request_params.update(kwargs) - path = ENDPOINTS['eastmoney_dapan_flow'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def eastmoney_hk_index_daily_kline( - self, - index_code: Any | None = None, - trade_date: Any | None = None, - start_date: Any | None = None, - end_date: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """东方财富港股指数日K. - - Endpoint: ``api/v1/market/data/eastmoney-hk-index-daily-kline``. - Method: ``GET``. - Documented endpoint: ``get_eastmoney_hk_index_daily_kline``. - - Args: - index_code: 指数代码，如 HSI / HSCEI / HSTECH；不传返回全部指数 (type: string; required: N). - trade_date: 交易日 YYYY-MM-DD；与 start_date/end_date 互斥 (type: string; required: N). - start_date: 区间起始日 YYYY-MM-DD；需与 end_date 同时提供 (type: string; required: N). - end_date: 区间结束日 YYYY-MM-DD；需与 start_date 同时提供 (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'index_code': index_code, 'trade_date': trade_date, 'start_date': start_date, 'end_date': end_date} - request_params.update(kwargs) - path = ENDPOINTS['eastmoney_hk_index_daily_kline'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def eastmoney_market_valuation( - self, - market_code: Any | None = None, - trade_date: Any | None = None, - start_date: Any | None = None, - end_date: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """东方财富市场估值. - - Endpoint: ``api/v1/market/data/eastmoney-market-valuation``. - Method: ``GET``. - Documented endpoint: ``get_eastmoney_market_valuation``. - - Args: - market_code: 市场代码，如 000001=上证指数、000300=沪深300；不传返回全部 (type: string; required: N). - trade_date: 交易日 YYYYMMDD；与 start_date/end_date 互斥 (type: string; required: N). - start_date: 区间起始日 YYYYMMDD；需与 end_date 同时提供 (type: string; required: N). - end_date: 区间结束日 YYYYMMDD；需与 start_date 同时提供 (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'market_code': market_code, 'trade_date': trade_date, 'start_date': start_date, 'end_date': end_date} - request_params.update(kwargs) - path = ENDPOINTS['eastmoney_market_valuation'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def eastmoney_rank( - self, - rank_group: Any | None = None, - market: Any | None = None, - trade_date: Any | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """东方财富股票排名. - - Endpoint: ``api/v1/market/data/eastmoney-rank``. - Method: ``GET``. - Documented endpoint: ``eastmoney_rank``. - - Args: - rank_group: 榜单组：`hot`（人气榜）/ `up`（飙升榜） (type: string; required: N). - market: 市场：`A`（A股）/ `HK`（港股）/ `US`（美股） (type: string; required: N). - trade_date: 交易日期，格式 `YYYY-MM-DD`，不传默认取最新 (type: string; required: N). - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'rank_group': rank_group, 'market': market, 'trade_date': trade_date} - request_params.update(kwargs) - return self._call_endpoint( - 'eastmoney_rank', - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def eastmoney_sector_flow( - self, - sector_code: Any | None = None, - sector_type: Any | None = None, - trade_date: Any | None = None, - start_date: Any | None = None, - end_date: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """东方财富板块资金流. - - Endpoint: ``api/v1/market/data/eastmoney-sector-flow``. - Method: ``GET``. - Documented endpoint: ``get_eastmoney_sector_flow``. - - Args: - sector_code: 板块代码，如 BK0488 (type: string; required: N). - sector_type: 板块类型：industry / concept / regional (type: string; required: N). - trade_date: 交易日 YYYYMMDD；与 start_date/end_date 互斥 (type: string; required: N). - start_date: 区间起始日 YYYYMMDD；需与 end_date 同时提供 (type: string; required: N). - end_date: 区间结束日 YYYYMMDD；需与 start_date 同时提供 (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'sector_code': sector_code, 'sector_type': sector_type, 'trade_date': trade_date, 'start_date': start_date, 'end_date': end_date} - request_params.update(kwargs) - path = ENDPOINTS['eastmoney_sector_flow'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def eastmoney_stock_flow( - self, - symbol: Any | None = None, - trade_date: Any | None = None, - start_date: Any | None = None, - end_date: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """东方财富个股资金流. - - Endpoint: ``api/v1/market/data/eastmoney-stock-flow``. - Method: ``GET``. - Documented endpoint: ``get_eastmoney_stock_flow``. - - Args: - symbol: 股票代码，如 600522 (type: string; required: N). - trade_date: 交易日 YYYYMMDD；与 start_date/end_date 互斥 (type: string; required: N). - start_date: 区间起始日 YYYYMMDD；需与 end_date 同时提供 (type: string; required: N). - end_date: 区间结束日 YYYYMMDD；需与 start_date 同时提供 (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'symbol': symbol, 'trade_date': trade_date, 'start_date': start_date, 'end_date': end_date} - request_params.update(kwargs) - path = ENDPOINTS['eastmoney_stock_flow'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def eastmoney_stock_valuation( - self, - symbol: Any | None = None, - trade_date: Any | None = None, - start_date: Any | None = None, - end_date: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """东方财富个股估值. - - Endpoint: ``api/v1/market/data/eastmoney-stock-valuation``. - Method: ``GET``. - Documented endpoint: ``get_eastmoney_stock_valuation``. - - Args: - symbol: 股票代码，如 000001；不传返回全部 (type: string; required: N). - trade_date: 交易日 YYYYMMDD；与 start_date/end_date 互斥 (type: string; required: N). - start_date: 区间起始日 YYYYMMDD；需与 end_date 同时提供 (type: string; required: N). - end_date: 区间结束日 YYYYMMDD；需与 start_date 同时提供 (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'symbol': symbol, 'trade_date': trade_date, 'start_date': start_date, 'end_date': end_date} - request_params.update(kwargs) - path = ENDPOINTS['eastmoney_stock_valuation'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def eastmoney_us_stock_daily_kline( - self, - stock_code: Any | None = None, - start_date: Any | None = None, - end_date: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """东方财富美股日OHLC. - - Endpoint: ``api/v1/market/data/eastmoney-us-stock-daily-ohlc``. - Method: ``GET``. - Documented endpoint: ``eastmoney_us_stock_daily_kline``. - - Args: - stock_code: 股票代码，如 AAPL (type: string; required: Y). - start_date: 起始日期（含），YYYY-MM-DD 或 YYYYMMDD；不传从最早开始 (type: string; required: N). - end_date: 截止日期（含），YYYY-MM-DD 或 YYYYMMDD；不传到最晚 (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'stock_code': stock_code, 'start_date': start_date, 'end_date': end_date} - request_params.update(kwargs) - path = ENDPOINTS['eastmoney_us_stock_daily_kline'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def eastmoney_us_stock_daily_ohlc( - self, - stock_code: Any | None = None, - start_date: Any | None = None, - end_date: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """东方财富美股日OHLC. - - Endpoint: ``api/v1/market/data/eastmoney-us-stock-daily-ohlc``. - Method: ``GET``. - Documented endpoint: ``eastmoney_us_stock_daily_kline``. - - Args: - stock_code: 股票代码，如 AAPL (type: string; required: Y). - start_date: 起始日期（含），YYYY-MM-DD 或 YYYYMMDD；不传从最早开始 (type: string; required: N). - end_date: 截止日期（含），YYYY-MM-DD 或 YYYYMMDD；不传到最晚 (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'stock_code': stock_code, 'start_date': start_date, 'end_date': end_date} - request_params.update(kwargs) - path = ENDPOINTS['eastmoney_us_stock_daily_ohlc'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def eastmoney_us_stock_latest_kline( - self, - stock_code: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """东方财富美股最新OHLC. - - Endpoint: ``api/v1/market/data/eastmoney-us-stock-latest-ohlc``. - Method: ``GET``. - Documented endpoint: ``eastmoney_us_stock_latest_kline``. - - Args: - stock_code: 股票代码，如 ADV；不传返回全部美股最新 K 线 (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'stock_code': stock_code} - request_params.update(kwargs) - path = ENDPOINTS['eastmoney_us_stock_latest_kline'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def eastmoney_us_stock_latest_ohlc( - self, - stock_code: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """东方财富美股最新OHLC. - - Endpoint: ``api/v1/market/data/eastmoney-us-stock-latest-ohlc``. - Method: ``GET``. - Documented endpoint: ``eastmoney_us_stock_latest_kline``. - - Args: - stock_code: 股票代码，如 ADV；不传返回全部美股最新 K 线 (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'stock_code': stock_code} - request_params.update(kwargs) - path = ENDPOINTS['eastmoney_us_stock_latest_ohlc'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def eastmoney_us_stock_list( - self, - refresh: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """东方财富美股列表. - - Endpoint: ``api/v1/market/data/eastmoney-us-stock-list``. - Method: ``GET``. - Documented endpoint: ``eastmoney_us_stock_list``. - - Args: - refresh: 为 true 时强制从 CSV 重新加载列表缓存 (type: bool; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'refresh': refresh} - request_params.update(kwargs) - path = ENDPOINTS['eastmoney_us_stock_list'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def hk_sh_stock_connect_members( - self, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """沪港通成份. - - Endpoint: ``api/v1/market/data/hk-sh-stock-connect-members``. - Method: ``GET``. - Documented endpoint: ``hk_sh_stock_connect_members``. - - Args: - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {} - request_params.update(kwargs) - return self._call_endpoint( - 'hk_sh_stock_connect_members', - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def hk_sz_stock_connect_members( - self, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """深港通成份. - - Endpoint: ``api/v1/market/data/hk-sz-stock-connect-members``. - Method: ``GET``. - Documented endpoint: ``hk_sz_stock_connect_members``. - - Args: - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {} - request_params.update(kwargs) - return self._call_endpoint( - 'hk_sz_stock_connect_members', - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def index_description_all( - self, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """指数基础信息. - - Endpoint: ``api/v1/market/data/index-description-all``. - Method: ``GET``. - Documented endpoint: ``index_description_all``. - - Args: - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {} - request_params.update(kwargs) - return self._call_endpoint( - 'index_description_all', - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def northbound( - self, - date: Any | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """北向资金交易. - - Endpoint: ``api/v1/market/data/northbound``. - Method: ``GET``. - Documented endpoint: ``northbound``. - - Args: - date: 交易日，格式 YYYYMMDD (type: string; required: Y). - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'date': date} - request_params.update(kwargs) - return self._call_endpoint( - 'northbound', - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def nth_trade_date( - self, - n: Any | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """第N个交易日. - - Endpoint: ``api/v1/market/data/time/get-nth-trade-date``. - Method: ``GET``. - Documented endpoint: ``get_nth_trade_date``. - - Args: - n: 需要获取的前 N 个交易日，N >= 1 (type: uint32; required: Y). - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'n': n} - request_params.update(kwargs) - return self._call_endpoint( - 'nth_trade_date', - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def price_change( - self, - stock_code: Any | None = None, - base_date: Any | None = None, - n: Any | None = None, - direction: Any | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """价格变动. - - Endpoint: ``api/v1/market/data/price/get-price-change``. - Method: ``GET``. - Documented endpoint: ``get_price_change``. - - Args: - stock_code: 目标股票 6 位纯数字代码，兼容沪市/深市/创业板/科创板 (type: string; required: Y). - base_date: 涨跌幅计算基准日，格式 YYYYMMDD (type: string; required: Y). - n: 需计算的有效交易日数量，建议不超过 365 (type: uint32; required: Y). - direction: 计算方向：forward（基准日为结束日）/ backward（基准日为开始日） (type: string; required: Y). - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'stock_code': stock_code, 'base_date': base_date, 'n': n, 'direction': direction} - request_params.update(kwargs) - return self._call_endpoint( - 'price_change', - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def search( - self, - query: Any | None = None, - limit: Any | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """标的搜索. - - Endpoint: ``api/v1/market/security/search``. - Method: ``GET``. - Documented endpoint: ``search``. - - Args: - query: 搜索关键词；支持名称、标的代码、拼音全拼/首字母；大小写不敏感，自动 trim (type: string; required: Y). - limit: 返回最大条数，默认 1 (type: int; required: N). - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'q': query, 'limit': limit} - request_params.update(kwargs) - return self._call_endpoint( - 'search', - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def semantic_search_news( - self, - query: Any | None = None, - limit: Any | None = None, - year: Any | None = None, - start_time: Any | None = None, - end_time: Any | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """新闻语义搜索. - - Endpoint: ``api/v1/market/data/semantic-search-news``. - Method: ``GET``. - Documented endpoint: ``semantic_search_news_handler``. - - Args: - query: 搜索文字 (type: string; required: Y). - limit: 返回条数，默认由服务端决定 (type: int; required: N). - year: 年份，限定搜索范围 (type: int; required: N). - start_time: 起始时间（带时区），与 end_time 同传时区间不超过 3 天 (type: datetime; required: N). - end_time: 结束时间（带时区），与 start_time 同传时区间不超过 3 天 (type: datetime; required: N). - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'query': query, 'limit': limit, 'year': year, 'start_time': start_time, 'end_time': end_time} - request_params.update(kwargs) - return self._call_endpoint( - 'semantic_search_news', - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def sh_hk_stock_connect_members( - self, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """沪股通成份. - - Endpoint: ``api/v1/market/data/sh-hk-stock-connect-members``. - Method: ``GET``. - Documented endpoint: ``sh_hk_stock_connect_members``. - - Args: - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {} - request_params.update(kwargs) - return self._call_endpoint( - 'sh_hk_stock_connect_members', - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def southbound( - self, - date: Any | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """南向资金交易. - - Endpoint: ``api/v1/market/data/southbound``. - Method: ``GET``. - Documented endpoint: ``southbound``. - - Args: - date: 交易日，格式 YYYYMMDD (type: string; required: Y). - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'date': date} - request_params.update(kwargs) - return self._call_endpoint( - 'southbound', - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def suspension_list( - self, - trade_date: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """停牌列表. - - Endpoint: ``api/v1/market/data/suspension-list``. - Method: ``GET``. - Documented endpoint: ``suspension_list``. - - Args: - trade_date: 交易日，格式 YYYYMMDD，默认当天 (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'trade_date': trade_date} - request_params.update(kwargs) - path = ENDPOINTS['suspension_list'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def sw_industry_constituent_history( - self, - industry_code: Any | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """申万行业成份股历史. - - Endpoint: ``api/v1/market/data/sw-industry/constituent-history``. - Method: ``GET``. - Documented endpoint: ``sw_industry_constituent_history``. - - Args: - industry_code: 行业代码，带 .SI 后缀，如 801010.SI (type: string; required: Y). - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'industry_code': industry_code} - request_params.update(kwargs) - return self._call_endpoint( - 'sw_industry_constituent_history', - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def sw_industry_daily_metrics( - self, - level: Any | None = None, - start_date: Any | None = None, - end_date: Any | None = None, - industry_code: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """申万行业日度指标. - - Endpoint: ``api/v1/market/data/sw-industry/daily-metrics``. - Method: ``GET``. - Documented endpoint: ``sw_industry_daily_metrics``. - - Args: - level: 行业层级：1/2/3 (type: int; required: Y). - start_date: 起始日期，YYYYMMDD (type: string; required: Y). - end_date: 截止日期，YYYYMMDD (type: string; required: Y). - industry_code: 行业代码，带 .SI 后缀，如 801010.SI (type: string; required: Y). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'level': level, 'start_date': start_date, 'end_date': end_date, 'industry_code': industry_code} - request_params.update(kwargs) - path = ENDPOINTS['sw_industry_daily_metrics'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def sw_industry_overview( - self, - date: Any | None = None, - level: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """申万行业总览. - - Endpoint: ``api/v1/market/data/sw-industry/overview``. - Method: ``GET``. - Documented endpoint: ``sw_industry_overview``. - - Args: - date: 交易日，格式 YYYYMMDD (type: string; required: Y). - level: 行业层级：1/2/3，不传返回全部 (type: int; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'date': date, 'level': level} - request_params.update(kwargs) - path = ENDPOINTS['sw_industry_overview'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def sz_hk_stock_connect_members( - self, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """深股通成份. - - Endpoint: ``api/v1/market/data/sz-hk-stock-connect-members``. - Method: ``GET``. - Documented endpoint: ``sz_hk_stock_connect_members``. - - Args: - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {} - request_params.update(kwargs) - return self._call_endpoint( - 'sz_hk_stock_connect_members', - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def ths_all_board_kline( - self, - start_date: Any | None = None, - end_date: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """同花顺全板块K线. - - Endpoint: ``api/v1/market/data/ths-all-board-kline``. - Method: ``GET``. - Documented endpoint: ``ths_all_board_kline``. - - Args: - start_date: 起始日期（含），YYYY-MM-DD 或 YYYYMMDD (type: string; required: N). - end_date: 截止日期（含），YYYY-MM-DD 或 YYYYMMDD (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'start_date': start_date, 'end_date': end_date} - request_params.update(kwargs) - path = ENDPOINTS['ths_all_board_kline'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def ths_board_kline( - self, - board_code: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """同花顺板块K线. - - Endpoint: ``api/v1/market/data/ths-board-kline``. - Method: ``GET``. - Documented endpoint: ``ths_board_kline``. - - Args: - board_code: 板块代码，如 886056 (type: string; required: Y). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'board_code': board_code} - request_params.update(kwargs) - path = ENDPOINTS['ths_board_kline'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def ths_board_list( - self, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """同花顺板块列表. - - Endpoint: ``api/v1/market/data/ths-board-list``. - Method: ``GET``. - Documented endpoint: ``ths_board_list``. - - Args: - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {} - request_params.update(kwargs) - return self._call_endpoint( - 'ths_board_list', - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def type_reports( - self, - rept_type: Any | None = None, - start_date: Any | None = None, - end_date: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """研报分类. - - Endpoint: ``api/v1/market/data/report/type-reports``. - Method: ``GET``. - Documented endpoint: ``type_reports``. - - Args: - rept_type: 研报类型：MacroReport / IndustryReport / BrokerMorningReport / StrategyReport / NewStockReport (type: string; required: Y). - start_date: 开始日期 YYYYMMDD (type: string; required: Y). - end_date: 结束日期 YYYYMMDD，不填默认与 `start_date` 相同 (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'rept_type': rept_type, 'start_date': start_date, 'end_date': end_date} - request_params.update(kwargs) - path = ENDPOINTS['type_reports'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def us_balance( - self, - stock_code: Any | None = None, - period: Any | None = None, - report_type: Any | None = None, - start_date: Any | None = None, - end_date: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """美股资产负债表. - - Endpoint: ``api/v1/market/data/us/us-balance``. - Method: ``GET``. - Documented endpoint: ``us_balance``. - - Args: - stock_code: 美股代码，纯代码不带后缀，如 NVDA (type: string; required: Y). - period: 财年（如 2024），匹配 stmt_year，非自然年 (type: int; required: N). - report_type: 报告期类型：Q1 / Q2 / Q3 / Q4 / H1 (type: string; required: N). - start_date: 报告期下界 YYYYMMDD（含），过滤 end_date (type: int; required: N). - end_date: 报告期上界 YYYYMMDD（含），过滤 end_date (type: int; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'stock_code': stock_code, 'period': period, 'report_type': report_type, 'start_date': start_date, 'end_date': end_date} - request_params.update(kwargs) - path = ENDPOINTS['us_balance'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - max_page_size=500, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def us_basic( - self, - stock_code: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """美股基础信息. - - Endpoint: ``api/v1/market/data/us/us-basic``. - Method: ``GET``. - Documented endpoint: ``us_basic``. - - Args: - stock_code: 美股代码（可选），纯代码如 NVDA；不传则分页返回全部 (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'stock_code': stock_code} - request_params.update(kwargs) - path = ENDPOINTS['us_basic'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - max_page_size=500, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def us_cashflow( - self, - stock_code: Any | None = None, - period: Any | None = None, - report_type: Any | None = None, - start_date: Any | None = None, - end_date: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """美股现金流. - - Endpoint: ``api/v1/market/data/us/us-cashflow``. - Method: ``GET``. - Documented endpoint: ``us_cashflow``. - - Args: - stock_code: 美股代码，纯代码不带后缀，如 NVDA (type: string; required: Y). - period: 财年（如 2024），匹配 stmt_year，非自然年 (type: int; required: N). - report_type: 报告期类型：Q1 / Q2 / Q3 / Q4 / H1 (type: string; required: N). - start_date: 报告期下界 YYYYMMDD（含），过滤 end_date (type: int; required: N). - end_date: 报告期上界 YYYYMMDD（含），过滤 end_date (type: int; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'stock_code': stock_code, 'period': period, 'report_type': report_type, 'start_date': start_date, 'end_date': end_date} - request_params.update(kwargs) - path = ENDPOINTS['us_cashflow'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - max_page_size=500, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def us_income( - self, - stock_code: Any | None = None, - period: Any | None = None, - report_type: Any | None = None, - start_date: Any | None = None, - end_date: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """美股利润表. - - Endpoint: ``api/v1/market/data/us/us-income``. - Method: ``GET``. - Documented endpoint: ``us_income``. - - Args: - stock_code: 美股代码，纯代码不带后缀，如 NVDA (type: string; required: Y). - period: 财年（如 2024），匹配 stmt_year，非自然年 (type: int; required: N). - report_type: 报告期类型：Q1 / Q2 / Q3 / Q4 / H1 (type: string; required: N). - start_date: 报告期下界 YYYYMMDD（含），过滤 end_date (type: int; required: N). - end_date: 报告期上界 YYYYMMDD（含），过滤 end_date (type: int; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'stock_code': stock_code, 'period': period, 'report_type': report_type, 'start_date': start_date, 'end_date': end_date} - request_params.update(kwargs) - path = ENDPOINTS['us_income'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - max_page_size=500, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def xueqiu_rank( - self, - rank_group: Any | None = None, - period: Any | None = None, - trade_date: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """雪球股票排名. - - Endpoint: ``api/v1/market/data/xueqiu-rank``. - Method: ``GET``. - Documented endpoint: ``xueqiu_rank``. - - Args: - rank_group: 榜单组：`follow`（关注）/ `tweet`（讨论）/ `deal`（交易） (type: string; required: N). - period: 周期：`7d`（本周新增）/ `total`（最热门） (type: string; required: N). - trade_date: 交易日期，格式 `YYYY-MM-DD`，不传默认取最新 (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'rank_group': rank_group, 'period': period, 'trade_date': trade_date} - request_params.update(kwargs) - path = ENDPOINTS['xueqiu_rank'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - max_page_size=100, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def yzxdr_detail( - self, - year: Any | None = None, - quarter: Any | None = None, - stock_code: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """除权除息明细. - - Endpoint: ``api/v1/market/data/yzxdr-detail``. - Method: ``GET``. - Documented endpoint: ``get_yzxdr_detail``. - - Args: - year: 年份（如 2026） (type: uint32; required: Y). - quarter: 季度，1-4 (type: uint32; required: Y). - stock_code: 股票代码，6 位数字 (type: string; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'year': year, 'quarter': quarter, 'stock_code': stock_code} - request_params.update(kwargs) - path = ENDPOINTS['yzxdr_detail'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - diff --git a/src/ftshare/apis/pledge.py b/src/ftshare/apis/pledge.py deleted file mode 100644 index 1981d91..0000000 --- a/src/ftshare/apis/pledge.py +++ /dev/null @@ -1,170 +0,0 @@ -"""FTShare pledge endpoint methods for FTShare market data.""" - -from __future__ import annotations - -from collections.abc import Sequence -from typing import Any - -from ..endpoints import ENDPOINTS - - -class PledgeApiMixin: - """Endpoint methods for the pledge API group.""" - - def pledge_summary( - self, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """股权质押汇总. - - Endpoint: ``api/v1/market/data/pledge/pledge-summary``. - Method: ``GET``. - Documented endpoint: ``stock_pledge_summary``. - - Args: - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {} - request_params.update(kwargs) - path = ENDPOINTS['pledge_summary'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def stock_pledge_detail( - self, - stock_code: Any | None = None, - is_last: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """股权质押明细. - - Endpoint: ``api/v1/market/data/pledge/pledge-detail``. - Method: ``GET``. - Documented endpoint: ``stock_pledge_detail``. - - Args: - stock_code: 股票代码（symbol.suffix 格式或纯代码）；不传时需配合 `is_last=true` (type: string; required: N). - is_last: 是否仅获取最新一期（无 `stock_code` 时必填为 true） (type: bool; required: N). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'stock_code': stock_code, 'is_last': is_last} - request_params.update(kwargs) - path = ENDPOINTS['stock_pledge_detail'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def stock_pledge_summary( - self, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """股权质押汇总. - - Endpoint: ``api/v1/market/data/pledge/pledge-summary``. - Method: ``GET``. - Documented endpoint: ``stock_pledge_summary``. - - Args: - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {} - request_params.update(kwargs) - path = ENDPOINTS['stock_pledge_summary'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - diff --git a/src/ftshare/apis/spot.py b/src/ftshare/apis/spot.py new file mode 100644 index 0000000..97efb2b --- /dev/null +++ b/src/ftshare/apis/spot.py @@ -0,0 +1,104 @@ +"""Spot commodity API methods grouped by ftshare-doc.""" + +from __future__ import annotations + +from collections.abc import Sequence +from typing import Any + +from ..endpoints import ENDPOINTS + + +class SpotApiMixin: + """Endpoint methods for the spot ftshare-doc topic.""" + + def bullion_price( + self, + symbol: Any | None = None, + start_date: Any | None = None, + end_date: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """贵金属价格. + + Endpoint: ``api/v1/market/data/bullion/price``. + Method: ``GET``. + Documented endpoint: ``get_bullion_price``. + + Args: + symbol: 标的代码，如 XAUUSD、AU9999 (type: string; required: Y). + start_date: 查询起始日期 YYYYMMDD (type: int; required: Y). + end_date: 查询结束日期 YYYYMMDD；与 start_date 跨度 ≤3 天 (type: int; required: Y). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'symbol': symbol, 'start_date': start_date, 'end_date': end_date} + request_params.update(kwargs) + path = ENDPOINTS['bullion_price'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def bullion_support_symbol( + self, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """贵金属支持标的. + + Endpoint: ``api/v1/market/data/bullion/support-symbol``. + Method: ``GET``. + Documented endpoint: ``get_bullion_support_symbol``. + + Args: + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {} + request_params.update(kwargs) + return self._call_endpoint( + 'bullion_support_symbol', + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) diff --git a/src/ftshare/apis/stock.py b/src/ftshare/apis/stock.py index d6b4fed..aee8557 100644 --- a/src/ftshare/apis/stock.py +++ b/src/ftshare/apis/stock.py @@ -1,4 +1,4 @@ -"""FTShare stock endpoint methods for FTShare market data.""" +"""Stock data API methods grouped by ftshare-doc.""" from __future__ import annotations @@ -9,7 +9,2551 @@ class StockApiMixin: - """Endpoint methods for the stock API group.""" + """Endpoint methods for the stock ftshare-doc topic.""" + + def balance( + self, + stock_code: Any | None = None, + year: Any | None = None, + report_type: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """A股资产负债表. + + Endpoint: ``api/v1/market/data/finance/balance``. + Method: ``GET``. + Documented endpoint: ``balance``. + + Args: + stock_code: A 股代码，6 位数字 + 后缀（如 600519.SH）；存在则进入模式A 单票查询 (type: string; required: N). + year: 年份（模式B 必填），如 2024 (type: int; required: N). + report_type: 报告期类型（模式B 必填）：q1 / q2 / q3 / annual（兼容 h1） (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'stock_code': stock_code, 'year': year, 'report_type': report_type} + request_params.update(kwargs) + path = ENDPOINTS['balance'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + max_page_size=500, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def cashflow( + self, + stock_code: Any | None = None, + year: Any | None = None, + report_type: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """A股现金流量表. + + Endpoint: ``api/v1/market/data/finance/cashflow``. + Method: ``GET``. + Documented endpoint: ``cashflow``. + + Args: + stock_code: A 股代码，6 位数字 + 后缀（如 000001.SZ）；存在则进入模式A 单票查询 (type: string; required: N). + year: 年份（模式B 必填），如 2024 (type: int; required: N). + report_type: 报告期类型（模式B 必填）：q1 / q2 / q3 / annual (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'stock_code': stock_code, 'year': year, 'report_type': report_type} + request_params.update(kwargs) + path = ENDPOINTS['cashflow'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + max_page_size=500, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def cashflow_stock_code( + self, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """现金流支持股票代码. + + Endpoint: ``api/v1/market/data/finance/cashflow-stock-code``. + Method: ``GET``. + Documented endpoint: ``get_cashflow_stock_code``. + + Args: + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {} + request_params.update(kwargs) + return self._call_endpoint( + 'cashflow_stock_code', + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def earnings_reports_paginated( + self, + stock_code: Any | None = None, + year: Any | None = None, + report_type: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """业绩快报. + + Endpoint: ``api/v1/market/data/finance/stock-performance-express``. + Method: ``GET``. + Documented endpoint: ``earnings_reports_paginated``. + + Args: + stock_code: A 股代码（如 000001.SZ）；传则查单票全部业绩快报 (type: string; required: N). + year: 年份（按报告期查询时必填），如 2024 (type: int; required: N). + report_type: 报告类型枚举（按报告期查询时必填）：q1 / q2 / q3 / annual / announcement (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'stock_code': stock_code, 'year': year, 'report_type': report_type} + request_params.update(kwargs) + path = ENDPOINTS['earnings_reports_paginated'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + max_page_size=500, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def income( + self, + stock_code: Any | None = None, + year: Any | None = None, + report_type: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """A股利润表. + + Endpoint: ``api/v1/market/data/finance/income``. + Method: ``GET``. + Documented endpoint: ``income``. + + Args: + stock_code: A 股代码，6 位数字 + 后缀（如 000001.SZ）；存在则进入模式A 单票查询 (type: string; required: N). + year: 年份（模式B 必填），如 2024 (type: int; required: N). + report_type: 报告期类型（模式B 必填）：q1 / q2 / q3 / annual（兼容 h1） (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'stock_code': stock_code, 'year': year, 'report_type': report_type} + request_params.update(kwargs) + path = ENDPOINTS['income'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + max_page_size=500, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def performance_forecasts_paginated( + self, + stock_code: Any | None = None, + year: Any | None = None, + report_type: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """业绩预告. + + Endpoint: ``api/v1/market/data/finance/stock-performance-forecast``. + Method: ``GET``. + Documented endpoint: ``performance_forecasts_paginated``. + + Args: + stock_code: A 股代码，6 位数字 + 后缀（如 000001.SZ）；存在则进入模式A 单票查询 (type: string; required: N). + year: 年份（模式B 必填），如 2024 (type: int; required: N). + report_type: 报告期类型（模式B 必填）：q1 / q2 / q3 / annual (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'stock_code': stock_code, 'year': year, 'report_type': report_type} + request_params.update(kwargs) + path = ENDPOINTS['performance_forecasts_paginated'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + max_page_size=500, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def goodwill_industry( + self, + date: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """商誉行业. + + Endpoint: ``api/v1/market/data/goodwill/industry``. + Method: ``GET``. + Documented endpoint: ``goodwill_industry``. + + Args: + date: 报告期，如 20250331 (type: string; required: Y). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'date': date} + request_params.update(kwargs) + path = ENDPOINTS['goodwill_industry'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def goodwill_market_overview( + self, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """商誉市场总览. + + Endpoint: ``api/v1/market/data/goodwill/market-overview``. + Method: ``GET``. + Documented endpoint: ``goodwill_market_overview``. + + Args: + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {} + request_params.update(kwargs) + return self._call_endpoint( + 'goodwill_market_overview', + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def goodwill_predict( + self, + date: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """商誉预测. + + Endpoint: ``api/v1/market/data/goodwill/predict``. + Method: ``GET``. + Documented endpoint: ``goodwill_predict``. + + Args: + date: 报告期，如 20250331 (type: string; required: Y). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'date': date} + request_params.update(kwargs) + path = ENDPOINTS['goodwill_predict'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def goodwill_stock_detail( + self, + date: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """商誉个股明细. + + Endpoint: ``api/v1/market/data/goodwill/stock-detail``. + Method: ``GET``. + Documented endpoint: ``goodwill_stock_detail``. + + Args: + date: 报告期，如 20250331 (type: string; required: Y). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'date': date} + request_params.update(kwargs) + path = ENDPOINTS['goodwill_stock_detail'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def goodwill_stock_impairment( + self, + date: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """商誉减值. + + Endpoint: ``api/v1/market/data/goodwill/stock-impairment``. + Method: ``GET``. + Documented endpoint: ``goodwill_stock_impairment``. + + Args: + date: 报告期，如 20250331 (type: string; required: Y). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'date': date} + request_params.update(kwargs) + path = ENDPOINTS['goodwill_stock_impairment'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def stk_ah_comparison( + self, + hk_code: Any | None = None, + ts_code: Any | None = None, + trade_date: Any | None = None, + start_date: Any | None = None, + end_date: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """AH股对比. + + Endpoint: ``api/v1/market/data/hk/stk-ah-comparison``. + Method: ``GET``. + Documented endpoint: ``get_stk_ah_comparison``. + + Args: + hk_code: 港股股票代码，支持 `700` 或 `00700.HK` (type: string; required: N). + ts_code: A 股股票代码，格式 `xxxxxx.SH/SZ/BJ` (type: string; required: N). + trade_date: 交易日期 YYYYMMDD (type: int32; required: N). + start_date: 起始日期 YYYYMMDD (type: int32; required: N). + end_date: 结束日期 YYYYMMDD (type: int32; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'hk_code': hk_code, 'ts_code': ts_code, 'trade_date': trade_date, 'start_date': start_date, 'end_date': end_date} + request_params.update(kwargs) + path = ENDPOINTS['stk_ah_comparison'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + max_page_size=1000, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def stock_float_holders( + self, + stock_code: Any | None = None, + is_last: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """十大流通股东. + + Endpoint: ``api/v1/market/data/holder/stock-holder-ften``. + Method: ``GET``. + Documented endpoint: ``stock_float_holders``. + + Args: + stock_code: 标的代码，指定时返回该标的全部历史数据 (type: string; required: N). + is_last: 是否取所有标的最新一期，true 时按 page/page_size 分页 (type: bool; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'stock_code': stock_code, 'is_last': is_last} + request_params.update(kwargs) + path = ENDPOINTS['stock_float_holders'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def stock_ggcg_em( + self, + symbol: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """东方财富股东增减持. + + Endpoint: ``api/v1/market/data/holder/stock-ggcg-em``. + Method: ``GET``. + Documented endpoint: ``stock_ggcg_em_handler``. + + Args: + symbol: 数据类型：全部 / 股东增持 / 股东减持，默认全部 (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'symbol': symbol} + request_params.update(kwargs) + path = ENDPOINTS['stock_ggcg_em'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def stock_ggmx( + self, + stock_code: Any | None = None, + change_direction: Any | None = None, + start_date: Any | None = None, + end_date: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """董监高持股变动. + + Endpoint: ``api/v1/market/data/holder/stock-ggmx``. + Method: ``GET``. + Documented endpoint: ``stock_ggmx_handler``. + + Args: + stock_code: 股票代码（如 600001），别名 stockCode (type: string; required: N). + change_direction: 变动方向：增持 / 减持，别名 changeDirection (type: string; required: N). + start_date: 变动日期起始 YYYY-MM-DD，别名 startDate (type: string; required: N). + end_date: 变动日期截止 YYYY-MM-DD，别名 endDate (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'stock_code': stock_code, 'change_direction': change_direction, 'start_date': start_date, 'end_date': end_date} + request_params.update(kwargs) + path = ENDPOINTS['stock_ggmx'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def stock_ggmx_buy_ranking( + self, + time_range: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """董监高增持排名. + + Endpoint: ``api/v1/market/data/holder/stock-ggmx-buy-ranking``. + Method: ``GET``. + Documented endpoint: ``stock_ggmx_buy_ranking_handler``. + + Args: + time_range: 时间范围：1m / 3m / 6m / 1y / 2y，默认 1m，别名 timeRange (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'time_range': time_range} + request_params.update(kwargs) + path = ENDPOINTS['stock_ggmx_buy_ranking'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def stock_ggmx_sell_ranking( + self, + time_range: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """董监高减持排名. + + Endpoint: ``api/v1/market/data/holder/stock-ggmx-sell-ranking``. + Method: ``GET``. + Documented endpoint: ``stock_ggmx_sell_ranking_handler``. + + Args: + time_range: 时间范围：1m / 3m / 6m / 1y / 2y，默认 1m，别名 timeRange (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'time_range': time_range} + request_params.update(kwargs) + path = ENDPOINTS['stock_ggmx_sell_ranking'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def stock_holders( + self, + stock_code: Any | None = None, + is_last: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """十大股东. + + Endpoint: ``api/v1/market/data/holder/stock-holder-ten``. + Method: ``GET``. + Documented endpoint: ``stock_holders``. + + Args: + stock_code: 标的代码，指定时返回该标的全部历史数据 (type: string; required: N). + is_last: 是否取所有标的最新一期，true 时按 page/page_size 分页 (type: bool; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'stock_code': stock_code, 'is_last': is_last} + request_params.update(kwargs) + path = ENDPOINTS['stock_holders'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def stock_holders_number( + self, + stock_code: Any | None = None, + is_last: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """股东人数. + + Endpoint: ``api/v1/market/data/holder/stock-holder-nums``. + Method: ``GET``. + Documented endpoint: ``stock_holders_number``. + + Args: + stock_code: 标的代码，指定时返回该标的全部历史数据 (type: string; required: N). + is_last: 是否取所有标的最新一期，true 时按 page/page_size 分页 (type: bool; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'stock_code': stock_code, 'is_last': is_last} + request_params.update(kwargs) + path = ENDPOINTS['stock_holders_number'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def stock_share_chg( + self, + stock_code: Any | None = None, + is_last: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """股东增减持. + + Endpoint: ``api/v1/market/data/holder/stock-share-chg``. + Method: ``GET``. + Documented endpoint: ``stock_share_chg``. + + Args: + stock_code: 标的代码，指定时返回该标的分页历史数据 (type: string; required: N). + is_last: 是否取所有标的最新一期，true 时按 page/page_size 分页 (type: bool; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'stock_code': stock_code, 'is_last': is_last} + request_params.update(kwargs) + path = ENDPOINTS['stock_share_chg'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def auction_results( + self, + ts_code: Any | None = None, + trade_date: Any | None = None, + start_date: Any | None = None, + end_date: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """集合竞价结果. + + Endpoint: ``api/v1/market/data/auction-results``. + Method: ``GET``. + Documented endpoint: ``auction_results``. + + Args: + ts_code: 股票代码，如 000001.XSHE (type: string; required: N). + trade_date: 交易日，格式 YYYYMMDD (type: string; required: N). + start_date: 起始日期，格式 YYYYMMDD (type: string; required: N). + end_date: 结束日期，格式 YYYYMMDD (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'ts_code': ts_code, 'trade_date': trade_date, 'start_date': start_date, 'end_date': end_date} + request_params.update(kwargs) + path = ENDPOINTS['auction_results'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def bse_mapping( + self, + o_code: Any | None = None, + n_code: Any | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """北交所映射. + + Endpoint: ``api/v1/market/data/bse-mapping``. + Method: ``GET``. + Documented endpoint: ``get_bse_mapping``. + + Args: + o_code: 旧代码（如 `838163.BJ`） (type: string; required: N). + n_code: 新代码（如 `920163.BJ`） (type: string; required: N). + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'o_code': o_code, 'n_code': n_code} + request_params.update(kwargs) + return self._call_endpoint( + 'bse_mapping', + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def company_list( + self, + stock_name: Any | None = None, + stock_code: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """公司列表. + + Endpoint: ``api/v1/market/data/company-list``. + Method: ``GET``. + Documented endpoint: ``get_company_list``. + + Args: + stock_name: 股票名称，精确匹配 (type: string; required: N). + stock_code: 股票代码，精确匹配 (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'stock_name': stock_name, 'stock_code': stock_code} + request_params.update(kwargs) + path = ENDPOINTS['company_list'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def eastmoney_board_constituents( + self, + board_code: Any | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """东方财富板块成份股. + + Endpoint: ``api/v1/market/data/eastmoney-board-constituents``. + Method: ``GET``. + Documented endpoint: ``eastmoney_board_constituents``. + + Args: + board_code: 板块代码，如 BK1024 (type: string; required: Y). + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'board_code': board_code} + request_params.update(kwargs) + return self._call_endpoint( + 'eastmoney_board_constituents', + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def eastmoney_board_daily_kline( + self, + board_code: Any | None = None, + start_date: Any | None = None, + end_date: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """东方财富板块日线OHLC. + + Endpoint: ``api/v1/market/data/eastmoney-board-daily-ohlc``. + Method: ``GET``. + Documented endpoint: ``eastmoney_board_daily_kline``. + + Args: + board_code: 板块代码，如 BK1024 (type: string; required: Y). + start_date: 起始日期（含），YYYY-MM-DD 或 YYYYMMDD (type: string; required: N). + end_date: 截止日期（含），YYYY-MM-DD 或 YYYYMMDD (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'board_code': board_code, 'start_date': start_date, 'end_date': end_date} + request_params.update(kwargs) + path = ENDPOINTS['eastmoney_board_daily_kline'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def eastmoney_board_latest_kline( + self, + board_code: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """东方财富板块最新OHLC. + + Endpoint: ``api/v1/market/data/eastmoney-board-latest-ohlc``. + Method: ``GET``. + Documented endpoint: ``eastmoney_board_latest_kline``. + + Args: + board_code: 板块代码，如 BK1024；不传则返回全部板块最新K线 (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'board_code': board_code} + request_params.update(kwargs) + path = ENDPOINTS['eastmoney_board_latest_kline'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def eastmoney_concept_boards( + self, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """东方财富概念板块. + + Endpoint: ``api/v1/market/data/eastmoney-concept-boards``. + Method: ``GET``. + Documented endpoint: ``eastmoney_concept_boards``. + + Args: + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {} + request_params.update(kwargs) + return self._call_endpoint( + 'eastmoney_concept_boards', + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def eastmoney_dapan_flow( + self, + trade_date: Any | None = None, + start_date: Any | None = None, + end_date: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """东方财富大盘资金流. + + Endpoint: ``api/v1/market/data/eastmoney-dapan-flow``. + Method: ``GET``. + Documented endpoint: ``get_eastmoney_dapan_flow``. + + Args: + trade_date: 交易日 YYYYMMDD；与 start_date/end_date 互斥 (type: string; required: N). + start_date: 区间起始日 YYYYMMDD；需与 end_date 同时提供 (type: string; required: N). + end_date: 区间结束日 YYYYMMDD；需与 start_date 同时提供 (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'trade_date': trade_date, 'start_date': start_date, 'end_date': end_date} + request_params.update(kwargs) + path = ENDPOINTS['eastmoney_dapan_flow'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def eastmoney_market_valuation( + self, + market_code: Any | None = None, + trade_date: Any | None = None, + start_date: Any | None = None, + end_date: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """东方财富市场估值. + + Endpoint: ``api/v1/market/data/eastmoney-market-valuation``. + Method: ``GET``. + Documented endpoint: ``get_eastmoney_market_valuation``. + + Args: + market_code: 市场代码，如 000001=上证指数、000300=沪深300；不传返回全部 (type: string; required: N). + trade_date: 交易日 YYYYMMDD；与 start_date/end_date 互斥 (type: string; required: N). + start_date: 区间起始日 YYYYMMDD；需与 end_date 同时提供 (type: string; required: N). + end_date: 区间结束日 YYYYMMDD；需与 start_date 同时提供 (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'market_code': market_code, 'trade_date': trade_date, 'start_date': start_date, 'end_date': end_date} + request_params.update(kwargs) + path = ENDPOINTS['eastmoney_market_valuation'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def eastmoney_rank( + self, + rank_group: Any | None = None, + market: Any | None = None, + trade_date: Any | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """东方财富股票排名. + + Endpoint: ``api/v1/market/data/eastmoney-rank``. + Method: ``GET``. + Documented endpoint: ``eastmoney_rank``. + + Args: + rank_group: 榜单组：`hot`（人气榜）/ `up`（飙升榜） (type: string; required: N). + market: 市场：`A`（A股）/ `HK`（港股）/ `US`（美股） (type: string; required: N). + trade_date: 交易日期，格式 `YYYY-MM-DD`，不传默认取最新 (type: string; required: N). + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'rank_group': rank_group, 'market': market, 'trade_date': trade_date} + request_params.update(kwargs) + return self._call_endpoint( + 'eastmoney_rank', + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def eastmoney_sector_flow( + self, + sector_code: Any | None = None, + sector_type: Any | None = None, + trade_date: Any | None = None, + start_date: Any | None = None, + end_date: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """东方财富板块资金流. + + Endpoint: ``api/v1/market/data/eastmoney-sector-flow``. + Method: ``GET``. + Documented endpoint: ``get_eastmoney_sector_flow``. + + Args: + sector_code: 板块代码，如 BK0488 (type: string; required: N). + sector_type: 板块类型：industry / concept / regional (type: string; required: N). + trade_date: 交易日 YYYYMMDD；与 start_date/end_date 互斥 (type: string; required: N). + start_date: 区间起始日 YYYYMMDD；需与 end_date 同时提供 (type: string; required: N). + end_date: 区间结束日 YYYYMMDD；需与 start_date 同时提供 (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'sector_code': sector_code, 'sector_type': sector_type, 'trade_date': trade_date, 'start_date': start_date, 'end_date': end_date} + request_params.update(kwargs) + path = ENDPOINTS['eastmoney_sector_flow'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def eastmoney_stock_flow( + self, + symbol: Any | None = None, + trade_date: Any | None = None, + start_date: Any | None = None, + end_date: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """东方财富个股资金流. + + Endpoint: ``api/v1/market/data/eastmoney-stock-flow``. + Method: ``GET``. + Documented endpoint: ``get_eastmoney_stock_flow``. + + Args: + symbol: 股票代码，如 600522 (type: string; required: N). + trade_date: 交易日 YYYYMMDD；与 start_date/end_date 互斥 (type: string; required: N). + start_date: 区间起始日 YYYYMMDD；需与 end_date 同时提供 (type: string; required: N). + end_date: 区间结束日 YYYYMMDD；需与 start_date 同时提供 (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'symbol': symbol, 'trade_date': trade_date, 'start_date': start_date, 'end_date': end_date} + request_params.update(kwargs) + path = ENDPOINTS['eastmoney_stock_flow'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def eastmoney_stock_valuation( + self, + symbol: Any | None = None, + trade_date: Any | None = None, + start_date: Any | None = None, + end_date: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """东方财富个股估值. + + Endpoint: ``api/v1/market/data/eastmoney-stock-valuation``. + Method: ``GET``. + Documented endpoint: ``get_eastmoney_stock_valuation``. + + Args: + symbol: 股票代码，如 000001；不传返回全部 (type: string; required: N). + trade_date: 交易日 YYYYMMDD；与 start_date/end_date 互斥 (type: string; required: N). + start_date: 区间起始日 YYYYMMDD；需与 end_date 同时提供 (type: string; required: N). + end_date: 区间结束日 YYYYMMDD；需与 start_date 同时提供 (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'symbol': symbol, 'trade_date': trade_date, 'start_date': start_date, 'end_date': end_date} + request_params.update(kwargs) + path = ENDPOINTS['eastmoney_stock_valuation'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def hk_sh_stock_connect_members( + self, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """沪港通成份. + + Endpoint: ``api/v1/market/data/hk-sh-stock-connect-members``. + Method: ``GET``. + Documented endpoint: ``hk_sh_stock_connect_members``. + + Args: + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {} + request_params.update(kwargs) + return self._call_endpoint( + 'hk_sh_stock_connect_members', + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def hk_sz_stock_connect_members( + self, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """深港通成份. + + Endpoint: ``api/v1/market/data/hk-sz-stock-connect-members``. + Method: ``GET``. + Documented endpoint: ``hk_sz_stock_connect_members``. + + Args: + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {} + request_params.update(kwargs) + return self._call_endpoint( + 'hk_sz_stock_connect_members', + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def northbound( + self, + date: Any | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """北向资金交易. + + Endpoint: ``api/v1/market/data/northbound``. + Method: ``GET``. + Documented endpoint: ``northbound``. + + Args: + date: 交易日，格式 YYYYMMDD (type: string; required: Y). + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'date': date} + request_params.update(kwargs) + return self._call_endpoint( + 'northbound', + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def nth_trade_date( + self, + n: Any | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """第N个交易日. + + Endpoint: ``api/v1/market/data/time/get-nth-trade-date``. + Method: ``GET``. + Documented endpoint: ``get_nth_trade_date``. + + Args: + n: 需要获取的前 N 个交易日，N >= 1 (type: uint32; required: Y). + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'n': n} + request_params.update(kwargs) + return self._call_endpoint( + 'nth_trade_date', + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def price_change( + self, + stock_code: Any | None = None, + base_date: Any | None = None, + n: Any | None = None, + direction: Any | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """价格变动. + + Endpoint: ``api/v1/market/data/price/get-price-change``. + Method: ``GET``. + Documented endpoint: ``get_price_change``. + + Args: + stock_code: 目标股票 6 位纯数字代码，兼容沪市/深市/创业板/科创板 (type: string; required: Y). + base_date: 涨跌幅计算基准日，格式 YYYYMMDD (type: string; required: Y). + n: 需计算的有效交易日数量，建议不超过 365 (type: uint32; required: Y). + direction: 计算方向：forward（基准日为结束日）/ backward（基准日为开始日） (type: string; required: Y). + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'stock_code': stock_code, 'base_date': base_date, 'n': n, 'direction': direction} + request_params.update(kwargs) + return self._call_endpoint( + 'price_change', + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def search( + self, + query: Any | None = None, + limit: Any | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """标的搜索. + + Endpoint: ``api/v1/market/security/search``. + Method: ``GET``. + Documented endpoint: ``search``. + + Args: + query: 搜索关键词；支持名称、标的代码、拼音全拼/首字母；大小写不敏感，自动 trim (type: string; required: Y). + limit: 返回最大条数，默认 1 (type: int; required: N). + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'q': query, 'limit': limit} + request_params.update(kwargs) + return self._call_endpoint( + 'search', + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def sh_hk_stock_connect_members( + self, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """沪股通成份. + + Endpoint: ``api/v1/market/data/sh-hk-stock-connect-members``. + Method: ``GET``. + Documented endpoint: ``sh_hk_stock_connect_members``. + + Args: + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {} + request_params.update(kwargs) + return self._call_endpoint( + 'sh_hk_stock_connect_members', + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def southbound( + self, + date: Any | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """南向资金交易. + + Endpoint: ``api/v1/market/data/southbound``. + Method: ``GET``. + Documented endpoint: ``southbound``. + + Args: + date: 交易日，格式 YYYYMMDD (type: string; required: Y). + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'date': date} + request_params.update(kwargs) + return self._call_endpoint( + 'southbound', + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def suspension_list( + self, + trade_date: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """停牌列表. + + Endpoint: ``api/v1/market/data/suspension-list``. + Method: ``GET``. + Documented endpoint: ``suspension_list``. + + Args: + trade_date: 交易日，格式 YYYYMMDD，默认当天 (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'trade_date': trade_date} + request_params.update(kwargs) + path = ENDPOINTS['suspension_list'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def sz_hk_stock_connect_members( + self, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """深股通成份. + + Endpoint: ``api/v1/market/data/sz-hk-stock-connect-members``. + Method: ``GET``. + Documented endpoint: ``sz_hk_stock_connect_members``. + + Args: + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {} + request_params.update(kwargs) + return self._call_endpoint( + 'sz_hk_stock_connect_members', + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def ths_all_board_kline( + self, + start_date: Any | None = None, + end_date: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """同花顺全板块K线. + + Endpoint: ``api/v1/market/data/ths-all-board-kline``. + Method: ``GET``. + Documented endpoint: ``ths_all_board_kline``. + + Args: + start_date: 起始日期（含），YYYY-MM-DD 或 YYYYMMDD (type: string; required: N). + end_date: 截止日期（含），YYYY-MM-DD 或 YYYYMMDD (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'start_date': start_date, 'end_date': end_date} + request_params.update(kwargs) + path = ENDPOINTS['ths_all_board_kline'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def ths_board_kline( + self, + board_code: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """同花顺板块K线. + + Endpoint: ``api/v1/market/data/ths-board-kline``. + Method: ``GET``. + Documented endpoint: ``ths_board_kline``. + + Args: + board_code: 板块代码，如 886056 (type: string; required: Y). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'board_code': board_code} + request_params.update(kwargs) + path = ENDPOINTS['ths_board_kline'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def ths_board_list( + self, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """同花顺板块列表. + + Endpoint: ``api/v1/market/data/ths-board-list``. + Method: ``GET``. + Documented endpoint: ``ths_board_list``. + + Args: + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {} + request_params.update(kwargs) + return self._call_endpoint( + 'ths_board_list', + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def xueqiu_rank( + self, + rank_group: Any | None = None, + period: Any | None = None, + trade_date: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """雪球股票排名. + + Endpoint: ``api/v1/market/data/xueqiu-rank``. + Method: ``GET``. + Documented endpoint: ``xueqiu_rank``. + + Args: + rank_group: 榜单组：`follow`（关注）/ `tweet`（讨论）/ `deal`（交易） (type: string; required: N). + period: 周期：`7d`（本周新增）/ `total`（最热门） (type: string; required: N). + trade_date: 交易日期，格式 `YYYY-MM-DD`，不传默认取最新 (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'rank_group': rank_group, 'period': period, 'trade_date': trade_date} + request_params.update(kwargs) + path = ENDPOINTS['xueqiu_rank'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + max_page_size=100, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def yzxdr_detail( + self, + year: Any | None = None, + quarter: Any | None = None, + stock_code: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """除权除息明细. + + Endpoint: ``api/v1/market/data/yzxdr-detail``. + Method: ``GET``. + Documented endpoint: ``get_yzxdr_detail``. + + Args: + year: 年份（如 2026） (type: uint32; required: Y). + quarter: 季度，1-4 (type: uint32; required: Y). + stock_code: 股票代码，6 位数字 (type: string; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'year': year, 'quarter': quarter, 'stock_code': stock_code} + request_params.update(kwargs) + path = ENDPOINTS['yzxdr_detail'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def pledge_summary( + self, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """股权质押汇总. + + Endpoint: ``api/v1/market/data/pledge/pledge-summary``. + Method: ``GET``. + Documented endpoint: ``stock_pledge_summary``. + + Args: + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {} + request_params.update(kwargs) + path = ENDPOINTS['pledge_summary'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def stock_pledge_detail( + self, + stock_code: Any | None = None, + is_last: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """股权质押明细. + + Endpoint: ``api/v1/market/data/pledge/pledge-detail``. + Method: ``GET``. + Documented endpoint: ``stock_pledge_detail``. + + Args: + stock_code: 股票代码（symbol.suffix 格式或纯代码）；不传时需配合 `is_last=true` (type: string; required: N). + is_last: 是否仅获取最新一期（无 `stock_code` 时必填为 true） (type: bool; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'stock_code': stock_code, 'is_last': is_last} + request_params.update(kwargs) + path = ENDPOINTS['stock_pledge_detail'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def stock_pledge_summary( + self, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """股权质押汇总. + + Endpoint: ``api/v1/market/data/pledge/pledge-summary``. + Method: ``GET``. + Documented endpoint: ``stock_pledge_summary``. + + Args: + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {} + request_params.update(kwargs) + path = ENDPOINTS['stock_pledge_summary'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) def abnormal_trading_details( self, @@ -595,96 +3139,43 @@ def stk_premarket( path, page=page, page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - max_page_size=500, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def stock_adjust_factor( - self, - symbol: Any | None = None, - trade_date: Any | None = None, - start_date: Any | None = None, - end_date: Any | None = None, - offset: Any | None = None, - limit: Any | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """股票复权因子. - - Endpoint: ``api/v1/market/data/stock-adjust-factor``. - Method: ``GET``. - Documented endpoint: ``stock_adjust_factor``. - - Args: - symbol: 股票代码，支持纯数字或带后缀格式；区间扫描必填 (type: string; required: N). - trade_date: 交易日期 YYYYMMDD；空则默认当天，非交易日回退前一交易日 (type: string; required: N). - start_date: 区间起始日期 YYYYMMDD；区间扫描必填且需配 symbol (type: string; required: N). - end_date: 区间结束日期 YYYYMMDD；区间扫描必填且需配 symbol (type: string; required: N). - offset: 返回结果起始偏移 (type: int; required: N). - limit: 返回结果最大条数 (type: int; required: N). - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'symbol': symbol, 'trade_date': trade_date, 'start_date': start_date, 'end_date': end_date, 'offset': offset, 'limit': limit} - request_params.update(kwargs) - return self._call_endpoint( - 'stock_adjust_factor', + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + max_page_size=500, raw=raw, fields=fields, as_dataframe=as_dataframe, **request_params, ) - def stock_announcements( + def stock_adjust_factor( self, - stock_code: Any | None = None, + symbol: Any | None = None, + trade_date: Any | None = None, start_date: Any | None = None, end_date: Any | None = None, - type: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, + offset: Any | None = None, + limit: Any | None = None, *, raw: bool = False, fields: Sequence[str] | str | None = None, as_dataframe: bool = True, **kwargs: Any, ) -> Any: - """公告列表. + """股票复权因子. - Endpoint: ``api/v1/market/data/announcements/stock-announcements``. + Endpoint: ``api/v1/market/data/stock-adjust-factor``. Method: ``GET``. - Documented endpoint: ``stock_announcements``. + Documented endpoint: ``stock_adjust_factor``. Args: - stock_code: 证券代码（按标的查询时必填） (type: string; required: N). - start_date: 开始日期 YYYYMMDD（按日期范围查询时必填） (type: string; required: N). - end_date: 结束日期 YYYYMMDD，不填默认当前时间 (type: string; required: N). - type: 查询类型，当前只支持 `stock` (type: string; required: Y). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. + symbol: 股票代码，支持纯数字或带后缀格式；区间扫描必填 (type: string; required: N). + trade_date: 交易日期 YYYYMMDD；空则默认当天，非交易日回退前一交易日 (type: string; required: N). + start_date: 区间起始日期 YYYYMMDD；区间扫描必填且需配 symbol (type: string; required: N). + end_date: 区间结束日期 YYYYMMDD；区间扫描必填且需配 symbol (type: string; required: N). + offset: 返回结果起始偏移 (type: int; required: N). + limit: 返回结果最大条数 (type: int; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -695,16 +3186,10 @@ def stock_announcements( ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page payloads when multi-page fetching is used with ``raw=True``. """ - request_params = {'stock_code': stock_code, 'start_date': start_date, 'end_date': end_date, 'type': type} + request_params = {'symbol': symbol, 'trade_date': trade_date, 'start_date': start_date, 'end_date': end_date, 'offset': offset, 'limit': limit} request_params.update(kwargs) - path = ENDPOINTS['stock_announcements'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, + return self._call_endpoint( + 'stock_adjust_factor', raw=raw, fields=fields, as_dataframe=as_dataframe, @@ -1114,57 +3599,6 @@ def stock_comment_score_em( **request_params, ) - def stock_dividends_paginated( - self, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """股票分红记录分页. - - Endpoint: ``api/v1/market/data/dividends``. - Method: ``GET``. - Documented endpoint: ``stock_dividends_paginated``. - - Args: - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {} - request_params.update(kwargs) - path = ENDPOINTS['stock_dividends_paginated'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - def stock_filter( self, board: Any | None = None, @@ -1379,44 +3813,6 @@ def stock_institution_share_holdings( **request_params, ) - def stock_intraday( - self, - symbol: Any | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """股票日内分时. - - Endpoint: ``api/v1/market/security/{symbol}/intraday``. - Method: ``GET``. - Documented endpoint: ``stock_intraday``. - - Args: - symbol: 标的代码 (type: SymbolKey; required: Y). - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {} - request_params.update(kwargs) - return self._call_endpoint( - 'stock_intraday', - path_params={'symbol': symbol}, - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - def stock_intraday_auction_volume( self, trade_date: Any | None = None, @@ -1576,31 +3972,72 @@ def stock_ipos( **request_params, ) - def stock_ipos_paginated( + def stock_list( + self, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """股票列表. + + Endpoint: ``api/v1/market/data/stock-list``. + Method: ``GET``. + Documented endpoint: ``get_stock_list``. + + Args: + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {} + request_params.update(kwargs) + return self._call_endpoint( + 'stock_list', + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) + + def stock_daec_stocks( self, + board: Any | None = None, page: int | None = None, page_size: int | None = None, limit: int | None = None, all_pages: bool = False, max_pages: int | None = None, + filter: Any | None = None, + order_by: Any | None = None, *, raw: bool = False, fields: Sequence[str] | str | None = None, as_dataframe: bool = True, **kwargs: Any, ) -> Any: - """股票IPO分页. + """A股行情列表（DAEC 全字段族）. - Endpoint: ``api/v1/market/data/stock-ipos``. + Endpoint: ``api/v1/market/data/daec/stocks/{board}``. Method: ``GET``. - Documented endpoint: ``stock_ipos_paginated``. + Documented endpoint: ``stock_daec_stocks``. Args: + board: 板块路径参数，如 all / xshg / xshe / bjse (type: string; required: Y). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. all_pages: Fetch and combine pages until the server reports the last page. max_pages: Optional safety cap for ``all_pages``. + filter: 筛选表达式，如 ``close > 10`` 或 ``name.contains("银行")`` (type: string; required: N). + order_by: 排序表达式，如 ``change_rate desc`` (type: string; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -1611,9 +4048,9 @@ def stock_ipos_paginated( ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page payloads when multi-page fetching is used with ``raw=True``. """ - request_params = {} + request_params = {'filter': filter, 'order_by': order_by} request_params.update(kwargs) - path = ENDPOINTS['stock_ipos_paginated'].path + path = self._format_path(ENDPOINTS['stock_daec_stocks'].path, {'board': board}) return self.get_paginated( path, page=page, @@ -1627,21 +4064,33 @@ def stock_ipos_paginated( **request_params, ) - def stock_list( + def stock_realtime_list( self, + board: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, *, raw: bool = False, fields: Sequence[str] | str | None = None, as_dataframe: bool = True, **kwargs: Any, ) -> Any: - """股票列表. + """A股行情列表（stock-list 实时行情族）. - Endpoint: ``api/v1/market/data/stock-list``. + Endpoint: ``api/v1/market/data/stock-list/{board}``. Method: ``GET``. - Documented endpoint: ``get_stock_list``. + Documented endpoint: ``stock_realtime_list``. Args: + board: 板块路径参数，如 chi-next / star / new (type: string; required: Y). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -1654,8 +4103,14 @@ def stock_list( """ request_params = {} request_params.update(kwargs) - return self._call_endpoint( - 'stock_list', + path = self._format_path(ENDPOINTS['stock_realtime_list'].path, {'board': board}) + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, raw=raw, fields=fields, as_dataframe=as_dataframe, @@ -1777,66 +4232,29 @@ def stock_prev_close( **request_params, ) - def stock_rating_top5( - self, - date: Any | None = None, - variant: Any | None = None, - type: Any | None = None, - *, - raw: bool = False, - fields: Sequence[str] | str | None = None, - as_dataframe: bool = True, - **kwargs: Any, - ) -> Any: - """飞兔股票评级Top5. - - Endpoint: ``api/v1/market/data/feitu/stock-rating-top5``. - Method: ``GET``. - Documented endpoint: ``stock_rating_top5``. - - Args: - date: 日期 YYYYMMDD (type: string; required: Y). - variant: 档位，如 300001（30w01）、300000（30w），默认 300001 (type: string; required: N). - type: 市场：all / xshg / xshe / bjse，默认 all (type: StockRatingMarketFilter; required: N). - raw: Return the decoded JSON payload without tabular extraction. - fields: Optional field list or comma-separated field string applied after extraction. - as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. - **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. - - Returns: - A pandas ``DataFrame`` by default, Python rows when - ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page - payloads when multi-page fetching is used with ``raw=True``. - """ - request_params = {'date': date, 'variant': variant, 'type': type} - request_params.update(kwargs) - return self._call_endpoint( - 'stock_rating_top5', - raw=raw, - fields=fields, - as_dataframe=as_dataframe, - **request_params, - ) - - def stock_related( + def stock_intraday_prices( self, symbol: Any | None = None, - limit: Any | None = None, + range: Any | None = None, + days: Any | None = None, + ts_ms: Any | None = None, *, raw: bool = False, fields: Sequence[str] | str | None = None, as_dataframe: bool = True, **kwargs: Any, ) -> Any: - """相关股票. + """标的分时数据. - Endpoint: ``api/v1/market/security/{symbol}/related``. + Endpoint: ``api/v1/market/data/daec/history/prices``. Method: ``GET``. - Documented endpoint: ``stock_related``. + Documented endpoint: ``stock_intraday_prices``. Args: - symbol: 标的代码 (type: SymbolKey; required: Y). - limit: 返回数量上限，服务端默认 3 (type: int; required: N). + symbol: 标的代码，如 600000.XSHG (type: string; required: Y). + range: 预置时间区间：Today / FiveDays (type: string; required: N). + days: 近 N 个交易日至今 (type: uint32; required: N). + ts_ms: 起始毫秒时间戳 (type: int64; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -1847,50 +4265,37 @@ def stock_related( ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page payloads when multi-page fetching is used with ``raw=True``. """ - request_params = {'limit': limit} + request_params = {'symbol': symbol, 'range': range, 'days': days, 'ts_ms': ts_ms} request_params.update(kwargs) return self._call_endpoint( - 'stock_related', - path_params={'symbol': symbol}, + 'stock_intraday_prices', raw=raw, fields=fields, as_dataframe=as_dataframe, **request_params, ) - def stock_reports( + def stock_rating_top5( self, - stock_code: Any | None = None, - start_date: Any | None = None, - end_date: Any | None = None, + date: Any | None = None, + variant: Any | None = None, type: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, *, raw: bool = False, fields: Sequence[str] | str | None = None, as_dataframe: bool = True, **kwargs: Any, ) -> Any: - """研报列表. + """飞兔股票评级Top5. - Endpoint: ``api/v1/market/data/report/stock-reports``. + Endpoint: ``api/v1/market/data/feitu/stock-rating-top5``. Method: ``GET``. - Documented endpoint: ``stock_reports``. + Documented endpoint: ``stock_rating_top5``. Args: - stock_code: 证券代码（按标的查询时必填） (type: string; required: N). - start_date: 开始日期 YYYYMMDD（按日期范围查询时必填） (type: string; required: N). - end_date: 结束日期 YYYYMMDD，不填默认当前时间 (type: string; required: N). - type: 查询类型，当前只支持 `stock` (type: string; required: Y). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. + date: 日期 YYYYMMDD (type: string; required: Y). + variant: 档位，如 300001（30w01）、300000（30w），默认 300001 (type: string; required: N). + type: 市场：all / xshg / xshe / bjse，默认 all (type: StockRatingMarketFilter; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -1901,16 +4306,10 @@ def stock_reports( ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page payloads when multi-page fetching is used with ``raw=True``. """ - request_params = {'stock_code': stock_code, 'start_date': start_date, 'end_date': end_date, 'type': type} + request_params = {'date': date, 'variant': variant, 'type': type} request_params.update(kwargs) - path = ENDPOINTS['stock_reports'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, + return self._call_endpoint( + 'stock_rating_top5', raw=raw, fields=fields, as_dataframe=as_dataframe, @@ -2153,4 +4552,3 @@ def stock_unlock_by_date( as_dataframe=as_dataframe, **request_params, ) - diff --git a/src/ftshare/apis/corporate.py b/src/ftshare/apis/unpublished.py similarity index 71% rename from src/ftshare/apis/corporate.py rename to src/ftshare/apis/unpublished.py index f98f651..aa17b3c 100644 --- a/src/ftshare/apis/corporate.py +++ b/src/ftshare/apis/unpublished.py @@ -1,4 +1,4 @@ -"""FTShare corporate endpoint methods for FTShare market data.""" +"""Unpublished API methods kept for compatibility.""" from __future__ import annotations @@ -8,28 +8,34 @@ from ..endpoints import ENDPOINTS -class CorporateApiMixin: - """Endpoint methods for the corporate API group.""" +class UnpublishedApiMixin: + """Endpoint methods for the unpublished ftshare-doc topic.""" - def major_contract( + def stock_dividends_paginated( self, - start_date: Any | None = None, - end_date: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, *, raw: bool = False, fields: Sequence[str] | str | None = None, as_dataframe: bool = True, **kwargs: Any, ) -> Any: - """重大合同. + """股票分红记录分页. - Endpoint: ``api/v1/market/data/corporate/contract``. + Endpoint: ``api/v1/market/data/dividends``. Method: ``GET``. - Documented endpoint: ``major_contract``. + Documented endpoint: ``stock_dividends_paginated``. Args: - start_date: 起始日期（YYYYMMDD），区间跨度 ≤ 3 天 (type: string; required: Y). - end_date: 结束日期（YYYYMMDD），区间跨度 ≤ 3 天 (type: string; required: Y). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -40,43 +46,39 @@ def major_contract( ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page payloads when multi-page fetching is used with ``raw=True``. """ - request_params = {'start_date': start_date, 'end_date': end_date} + request_params = {} request_params.update(kwargs) - return self._call_endpoint( - 'major_contract', + path = ENDPOINTS['stock_dividends_paginated'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, raw=raw, fields=fields, as_dataframe=as_dataframe, **request_params, ) - def major_contract_by_symbol( + def stock_intraday( self, symbol: Any | None = None, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, *, raw: bool = False, fields: Sequence[str] | str | None = None, as_dataframe: bool = True, **kwargs: Any, ) -> Any: - """重大合同按标的. + """股票日内分时. - Endpoint: ``api/v1/market/data/corporate/contract/by-symbol``. + Endpoint: ``api/v1/market/security/{symbol}/intraday``. Method: ``GET``. - Documented endpoint: ``major_contract_by_symbol``. + Documented endpoint: ``stock_intraday``. Args: - symbol: 证券代码（标的） (type: string; required: Y). - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. + symbol: 标的代码 (type: SymbolKey; required: Y). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -87,23 +89,18 @@ def major_contract_by_symbol( ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page payloads when multi-page fetching is used with ``raw=True``. """ - request_params = {'symbol': symbol} + request_params = {} request_params.update(kwargs) - path = ENDPOINTS['major_contract_by_symbol'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, + return self._call_endpoint( + 'stock_intraday', + path_params={'symbol': symbol}, raw=raw, fields=fields, as_dataframe=as_dataframe, **request_params, ) - def major_contract_summary( + def stock_ipos_paginated( self, page: int | None = None, page_size: int | None = None, @@ -116,11 +113,11 @@ def major_contract_summary( as_dataframe: bool = True, **kwargs: Any, ) -> Any: - """重大合同汇总. + """股票IPO分页. - Endpoint: ``api/v1/market/data/corporate/contract/summary``. + Endpoint: ``api/v1/market/data/stock-ipos``. Method: ``GET``. - Documented endpoint: ``major_contract_summary``. + Documented endpoint: ``stock_ipos_paginated``. Args: page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. @@ -140,7 +137,7 @@ def major_contract_summary( """ request_params = {} request_params.update(kwargs) - path = ENDPOINTS['major_contract_summary'].path + path = ENDPOINTS['stock_ipos_paginated'].path return self.get_paginated( path, page=page, @@ -154,31 +151,25 @@ def major_contract_summary( **request_params, ) - def shareholders_meeting( + def stock_related( self, - page: int | None = None, - page_size: int | None = None, - limit: int | None = None, - all_pages: bool = False, - max_pages: int | None = None, + symbol: Any | None = None, + limit: Any | None = None, *, raw: bool = False, fields: Sequence[str] | str | None = None, as_dataframe: bool = True, **kwargs: Any, ) -> Any: - """股东大会. + """相关股票. - Endpoint: ``api/v1/market/data/corporate/meeting``. + Endpoint: ``api/v1/market/security/{symbol}/related``. Method: ``GET``. - Documented endpoint: ``shareholders_meeting``. + Documented endpoint: ``stock_related``. Args: - page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. - page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. - limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. - all_pages: Fetch and combine pages until the server reports the last page. - max_pages: Optional safety cap for ``all_pages``. + symbol: 标的代码 (type: SymbolKey; required: Y). + limit: 返回数量上限，服务端默认 3 (type: int; required: N). raw: Return the decoded JSON payload without tabular extraction. fields: Optional field list or comma-separated field string applied after extraction. as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. @@ -189,19 +180,13 @@ def shareholders_meeting( ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page payloads when multi-page fetching is used with ``raw=True``. """ - request_params = {} + request_params = {'limit': limit} request_params.update(kwargs) - path = ENDPOINTS['shareholders_meeting'].path - return self.get_paginated( - path, - page=page, - page_size=page_size, - limit=limit, - all_pages=all_pages, - max_pages=max_pages, + return self._call_endpoint( + 'stock_related', + path_params={'symbol': symbol}, raw=raw, fields=fields, as_dataframe=as_dataframe, **request_params, ) - diff --git a/src/ftshare/apis/holder.py b/src/ftshare/apis/us.py similarity index 65% rename from src/ftshare/apis/holder.py rename to src/ftshare/apis/us.py index 2a738ee..9e27c20 100644 --- a/src/ftshare/apis/holder.py +++ b/src/ftshare/apis/us.py @@ -1,4 +1,4 @@ -"""FTShare holder endpoint methods for FTShare market data.""" +"""US market API methods grouped by ftshare-doc.""" from __future__ import annotations @@ -8,13 +8,14 @@ from ..endpoints import ENDPOINTS -class HolderApiMixin: - """Endpoint methods for the holder API group.""" +class UsApiMixin: + """Endpoint methods for the us ftshare-doc topic.""" - def stock_float_holders( + def eastmoney_us_stock_daily_kline( self, stock_code: Any | None = None, - is_last: Any | None = None, + start_date: Any | None = None, + end_date: Any | None = None, page: int | None = None, page_size: int | None = None, limit: int | None = None, @@ -26,15 +27,16 @@ def stock_float_holders( as_dataframe: bool = True, **kwargs: Any, ) -> Any: - """十大流通股东. + """东方财富美股日OHLC. - Endpoint: ``api/v1/market/data/holder/stock-holder-ften``. + Endpoint: ``api/v1/market/data/eastmoney-us-stock-daily-ohlc``. Method: ``GET``. - Documented endpoint: ``stock_float_holders``. + Documented endpoint: ``eastmoney_us_stock_daily_kline``. Args: - stock_code: 标的代码，指定时返回该标的全部历史数据 (type: string; required: N). - is_last: 是否取所有标的最新一期，true 时按 page/page_size 分页 (type: bool; required: N). + stock_code: 股票代码，如 AAPL (type: string; required: Y). + start_date: 起始日期（含），YYYY-MM-DD 或 YYYYMMDD；不传从最早开始 (type: string; required: N). + end_date: 截止日期（含），YYYY-MM-DD 或 YYYYMMDD；不传到最晚 (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -50,9 +52,9 @@ def stock_float_holders( ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page payloads when multi-page fetching is used with ``raw=True``. """ - request_params = {'stock_code': stock_code, 'is_last': is_last} + request_params = {'stock_code': stock_code, 'start_date': start_date, 'end_date': end_date} request_params.update(kwargs) - path = ENDPOINTS['stock_float_holders'].path + path = ENDPOINTS['eastmoney_us_stock_daily_kline'].path return self.get_paginated( path, page=page, @@ -66,9 +68,11 @@ def stock_float_holders( **request_params, ) - def stock_ggcg_em( + def eastmoney_us_stock_daily_ohlc( self, - symbol: Any | None = None, + stock_code: Any | None = None, + start_date: Any | None = None, + end_date: Any | None = None, page: int | None = None, page_size: int | None = None, limit: int | None = None, @@ -80,14 +84,16 @@ def stock_ggcg_em( as_dataframe: bool = True, **kwargs: Any, ) -> Any: - """东方财富股东增减持. + """东方财富美股日OHLC. - Endpoint: ``api/v1/market/data/holder/stock-ggcg-em``. + Endpoint: ``api/v1/market/data/eastmoney-us-stock-daily-ohlc``. Method: ``GET``. - Documented endpoint: ``stock_ggcg_em_handler``. + Documented endpoint: ``eastmoney_us_stock_daily_kline``. Args: - symbol: 数据类型：全部 / 股东增持 / 股东减持，默认全部 (type: string; required: N). + stock_code: 股票代码，如 AAPL (type: string; required: Y). + start_date: 起始日期（含），YYYY-MM-DD 或 YYYYMMDD；不传从最早开始 (type: string; required: N). + end_date: 截止日期（含），YYYY-MM-DD 或 YYYYMMDD；不传到最晚 (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -103,9 +109,9 @@ def stock_ggcg_em( ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page payloads when multi-page fetching is used with ``raw=True``. """ - request_params = {'symbol': symbol} + request_params = {'stock_code': stock_code, 'start_date': start_date, 'end_date': end_date} request_params.update(kwargs) - path = ENDPOINTS['stock_ggcg_em'].path + path = ENDPOINTS['eastmoney_us_stock_daily_ohlc'].path return self.get_paginated( path, page=page, @@ -119,12 +125,9 @@ def stock_ggcg_em( **request_params, ) - def stock_ggmx( + def eastmoney_us_stock_latest_kline( self, stock_code: Any | None = None, - change_direction: Any | None = None, - start_date: Any | None = None, - end_date: Any | None = None, page: int | None = None, page_size: int | None = None, limit: int | None = None, @@ -136,17 +139,14 @@ def stock_ggmx( as_dataframe: bool = True, **kwargs: Any, ) -> Any: - """董监高持股变动. + """东方财富美股最新OHLC. - Endpoint: ``api/v1/market/data/holder/stock-ggmx``. + Endpoint: ``api/v1/market/data/eastmoney-us-stock-latest-ohlc``. Method: ``GET``. - Documented endpoint: ``stock_ggmx_handler``. + Documented endpoint: ``eastmoney_us_stock_latest_kline``. Args: - stock_code: 股票代码（如 600001），别名 stockCode (type: string; required: N). - change_direction: 变动方向：增持 / 减持，别名 changeDirection (type: string; required: N). - start_date: 变动日期起始 YYYY-MM-DD，别名 startDate (type: string; required: N). - end_date: 变动日期截止 YYYY-MM-DD，别名 endDate (type: string; required: N). + stock_code: 股票代码，如 ADV；不传返回全部美股最新 K 线 (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -162,9 +162,9 @@ def stock_ggmx( ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page payloads when multi-page fetching is used with ``raw=True``. """ - request_params = {'stock_code': stock_code, 'change_direction': change_direction, 'start_date': start_date, 'end_date': end_date} + request_params = {'stock_code': stock_code} request_params.update(kwargs) - path = ENDPOINTS['stock_ggmx'].path + path = ENDPOINTS['eastmoney_us_stock_latest_kline'].path return self.get_paginated( path, page=page, @@ -178,9 +178,9 @@ def stock_ggmx( **request_params, ) - def stock_ggmx_buy_ranking( + def eastmoney_us_stock_latest_ohlc( self, - time_range: Any | None = None, + stock_code: Any | None = None, page: int | None = None, page_size: int | None = None, limit: int | None = None, @@ -192,14 +192,14 @@ def stock_ggmx_buy_ranking( as_dataframe: bool = True, **kwargs: Any, ) -> Any: - """董监高增持排名. + """东方财富美股最新OHLC. - Endpoint: ``api/v1/market/data/holder/stock-ggmx-buy-ranking``. + Endpoint: ``api/v1/market/data/eastmoney-us-stock-latest-ohlc``. Method: ``GET``. - Documented endpoint: ``stock_ggmx_buy_ranking_handler``. + Documented endpoint: ``eastmoney_us_stock_latest_kline``. Args: - time_range: 时间范围：1m / 3m / 6m / 1y / 2y，默认 1m，别名 timeRange (type: string; required: N). + stock_code: 股票代码，如 ADV；不传返回全部美股最新 K 线 (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -215,9 +215,9 @@ def stock_ggmx_buy_ranking( ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page payloads when multi-page fetching is used with ``raw=True``. """ - request_params = {'time_range': time_range} + request_params = {'stock_code': stock_code} request_params.update(kwargs) - path = ENDPOINTS['stock_ggmx_buy_ranking'].path + path = ENDPOINTS['eastmoney_us_stock_latest_ohlc'].path return self.get_paginated( path, page=page, @@ -231,9 +231,9 @@ def stock_ggmx_buy_ranking( **request_params, ) - def stock_ggmx_sell_ranking( + def eastmoney_us_stock_list( self, - time_range: Any | None = None, + refresh: Any | None = None, page: int | None = None, page_size: int | None = None, limit: int | None = None, @@ -245,14 +245,14 @@ def stock_ggmx_sell_ranking( as_dataframe: bool = True, **kwargs: Any, ) -> Any: - """董监高减持排名. + """东方财富美股列表. - Endpoint: ``api/v1/market/data/holder/stock-ggmx-sell-ranking``. + Endpoint: ``api/v1/market/data/eastmoney-us-stock-list``. Method: ``GET``. - Documented endpoint: ``stock_ggmx_sell_ranking_handler``. + Documented endpoint: ``eastmoney_us_stock_list``. Args: - time_range: 时间范围：1m / 3m / 6m / 1y / 2y，默认 1m，别名 timeRange (type: string; required: N). + refresh: 为 true 时强制从 CSV 重新加载列表缓存 (type: bool; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -268,9 +268,9 @@ def stock_ggmx_sell_ranking( ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page payloads when multi-page fetching is used with ``raw=True``. """ - request_params = {'time_range': time_range} + request_params = {'refresh': refresh} request_params.update(kwargs) - path = ENDPOINTS['stock_ggmx_sell_ranking'].path + path = ENDPOINTS['eastmoney_us_stock_list'].path return self.get_paginated( path, page=page, @@ -284,10 +284,13 @@ def stock_ggmx_sell_ranking( **request_params, ) - def stock_holders( + def us_balance( self, stock_code: Any | None = None, - is_last: Any | None = None, + period: Any | None = None, + report_type: Any | None = None, + start_date: Any | None = None, + end_date: Any | None = None, page: int | None = None, page_size: int | None = None, limit: int | None = None, @@ -299,15 +302,18 @@ def stock_holders( as_dataframe: bool = True, **kwargs: Any, ) -> Any: - """十大股东. + """美股资产负债表. - Endpoint: ``api/v1/market/data/holder/stock-holder-ten``. + Endpoint: ``api/v1/market/data/us/us-balance``. Method: ``GET``. - Documented endpoint: ``stock_holders``. + Documented endpoint: ``us_balance``. Args: - stock_code: 标的代码，指定时返回该标的全部历史数据 (type: string; required: N). - is_last: 是否取所有标的最新一期，true 时按 page/page_size 分页 (type: bool; required: N). + stock_code: 美股代码，纯代码不带后缀，如 NVDA (type: string; required: Y). + period: 财年（如 2024），匹配 stmt_year，非自然年 (type: int; required: N). + report_type: 报告期类型：Q1 / Q2 / Q3 / Q4 / H1 (type: string; required: N). + start_date: 报告期下界 YYYYMMDD（含），过滤 end_date (type: int; required: N). + end_date: 报告期上界 YYYYMMDD（含），过滤 end_date (type: int; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -323,9 +329,9 @@ def stock_holders( ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page payloads when multi-page fetching is used with ``raw=True``. """ - request_params = {'stock_code': stock_code, 'is_last': is_last} + request_params = {'stock_code': stock_code, 'period': period, 'report_type': report_type, 'start_date': start_date, 'end_date': end_date} request_params.update(kwargs) - path = ENDPOINTS['stock_holders'].path + path = ENDPOINTS['us_balance'].path return self.get_paginated( path, page=page, @@ -333,16 +339,16 @@ def stock_holders( limit=limit, all_pages=all_pages, max_pages=max_pages, + max_page_size=500, raw=raw, fields=fields, as_dataframe=as_dataframe, **request_params, ) - def stock_holders_number( + def us_basic( self, stock_code: Any | None = None, - is_last: Any | None = None, page: int | None = None, page_size: int | None = None, limit: int | None = None, @@ -354,15 +360,14 @@ def stock_holders_number( as_dataframe: bool = True, **kwargs: Any, ) -> Any: - """股东人数. + """美股基础信息. - Endpoint: ``api/v1/market/data/holder/stock-holder-nums``. + Endpoint: ``api/v1/market/data/us/us-basic``. Method: ``GET``. - Documented endpoint: ``stock_holders_number``. + Documented endpoint: ``us_basic``. Args: - stock_code: 标的代码，指定时返回该标的全部历史数据 (type: string; required: N). - is_last: 是否取所有标的最新一期，true 时按 page/page_size 分页 (type: bool; required: N). + stock_code: 美股代码（可选），纯代码如 NVDA；不传则分页返回全部 (type: string; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -378,9 +383,9 @@ def stock_holders_number( ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page payloads when multi-page fetching is used with ``raw=True``. """ - request_params = {'stock_code': stock_code, 'is_last': is_last} + request_params = {'stock_code': stock_code} request_params.update(kwargs) - path = ENDPOINTS['stock_holders_number'].path + path = ENDPOINTS['us_basic'].path return self.get_paginated( path, page=page, @@ -388,16 +393,20 @@ def stock_holders_number( limit=limit, all_pages=all_pages, max_pages=max_pages, + max_page_size=500, raw=raw, fields=fields, as_dataframe=as_dataframe, **request_params, ) - def stock_share_chg( + def us_cashflow( self, stock_code: Any | None = None, - is_last: Any | None = None, + period: Any | None = None, + report_type: Any | None = None, + start_date: Any | None = None, + end_date: Any | None = None, page: int | None = None, page_size: int | None = None, limit: int | None = None, @@ -409,15 +418,18 @@ def stock_share_chg( as_dataframe: bool = True, **kwargs: Any, ) -> Any: - """股东增减持. + """美股现金流. - Endpoint: ``api/v1/market/data/holder/stock-share-chg``. + Endpoint: ``api/v1/market/data/us/us-cashflow``. Method: ``GET``. - Documented endpoint: ``stock_share_chg``. + Documented endpoint: ``us_cashflow``. Args: - stock_code: 标的代码，指定时返回该标的分页历史数据 (type: string; required: N). - is_last: 是否取所有标的最新一期，true 时按 page/page_size 分页 (type: bool; required: N). + stock_code: 美股代码，纯代码不带后缀，如 NVDA (type: string; required: Y). + period: 财年（如 2024），匹配 stmt_year，非自然年 (type: int; required: N). + report_type: 报告期类型：Q1 / Q2 / Q3 / Q4 / H1 (type: string; required: N). + start_date: 报告期下界 YYYYMMDD（含），过滤 end_date (type: int; required: N). + end_date: 报告期上界 YYYYMMDD（含），过滤 end_date (type: int; required: N). page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. @@ -433,9 +445,9 @@ def stock_share_chg( ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page payloads when multi-page fetching is used with ``raw=True``. """ - request_params = {'stock_code': stock_code, 'is_last': is_last} + request_params = {'stock_code': stock_code, 'period': period, 'report_type': report_type, 'start_date': start_date, 'end_date': end_date} request_params.update(kwargs) - path = ENDPOINTS['stock_share_chg'].path + path = ENDPOINTS['us_cashflow'].path return self.get_paginated( path, page=page, @@ -443,9 +455,71 @@ def stock_share_chg( limit=limit, all_pages=all_pages, max_pages=max_pages, + max_page_size=500, raw=raw, fields=fields, as_dataframe=as_dataframe, **request_params, ) + def us_income( + self, + stock_code: Any | None = None, + period: Any | None = None, + report_type: Any | None = None, + start_date: Any | None = None, + end_date: Any | None = None, + page: int | None = None, + page_size: int | None = None, + limit: int | None = None, + all_pages: bool = False, + max_pages: int | None = None, + *, + raw: bool = False, + fields: Sequence[str] | str | None = None, + as_dataframe: bool = True, + **kwargs: Any, + ) -> Any: + """美股利润表. + + Endpoint: ``api/v1/market/data/us/us-income``. + Method: ``GET``. + Documented endpoint: ``us_income``. + + Args: + stock_code: 美股代码，纯代码不带后缀，如 NVDA (type: string; required: Y). + period: 财年（如 2024），匹配 stmt_year，非自然年 (type: int; required: N). + report_type: 报告期类型：Q1 / Q2 / Q3 / Q4 / H1 (type: string; required: N). + start_date: 报告期下界 YYYYMMDD（含），过滤 end_date (type: int; required: N). + end_date: 报告期上界 YYYYMMDD（含），过滤 end_date (type: int; required: N). + page: Page number, starting from 1. If omitted, the server default is used unless ``limit`` or ``all_pages`` is set. + page_size: Rows per page. The SDK validates this against the endpoint-specific maximum. + limit: Maximum number of rows to return. The SDK may fetch multiple pages to satisfy this limit. + all_pages: Fetch and combine pages until the server reports the last page. + max_pages: Optional safety cap for ``all_pages``. + raw: Return the decoded JSON payload without tabular extraction. + fields: Optional field list or comma-separated field string applied after extraction. + as_dataframe: Return a pandas ``DataFrame`` by default; set to ``False`` for Python rows. + **kwargs: Extra request parameters forwarded unchanged. Useful when the service adds parameters before the SDK is regenerated. + + Returns: + A pandas ``DataFrame`` by default, Python rows when + ``as_dataframe=False``, raw JSON when ``raw=True``, or raw page + payloads when multi-page fetching is used with ``raw=True``. + """ + request_params = {'stock_code': stock_code, 'period': period, 'report_type': report_type, 'start_date': start_date, 'end_date': end_date} + request_params.update(kwargs) + path = ENDPOINTS['us_income'].path + return self.get_paginated( + path, + page=page, + page_size=page_size, + limit=limit, + all_pages=all_pages, + max_pages=max_pages, + max_page_size=500, + raw=raw, + fields=fields, + as_dataframe=as_dataframe, + **request_params, + ) diff --git a/src/ftshare/base.py b/src/ftshare/base.py index 210aee0..c22cb05 100644 --- a/src/ftshare/base.py +++ b/src/ftshare/base.py @@ -362,13 +362,15 @@ def fetch_all( return result def _url_for(self, path: str) -> str: - """Build the final URL for an endpoint path without duplicating ``data/``.""" + """Build the final URL for an endpoint path without duplicating gateway prefixes.""" clean_path = path.strip() if clean_path.startswith("http://") or clean_path.startswith("https://"): return clean_path clean_path = clean_path.lstrip("/") - if clean_path.startswith("data/"): - clean_path = clean_path[len("data/") :] + for prefix in ("gateway/", "data/"): + if clean_path.startswith(prefix): + clean_path = clean_path[len(prefix) :] + break return self.base_url + clean_path @staticmethod diff --git a/src/ftshare/client.py b/src/ftshare/client.py index 2202725..723b8ac 100644 --- a/src/ftshare/client.py +++ b/src/ftshare/client.py @@ -1,48 +1,46 @@ -"""Public synchronous FTShare client assembled from domain API mixins.""" +"""Public synchronous FTShare client assembled from ftshare-doc topic mixins.""" from __future__ import annotations from collections.abc import Mapping from .apis import ( - CorporateApiMixin, + BondApiMixin, EconomicApiMixin, EtfApiMixin, - FinanceApiMixin, + ForexApiMixin, FundApiMixin, FuturesApiMixin, - GlobalIndexApiMixin, - GoodwillApiMixin, HkApiMixin, - HolderApiMixin, IndexApiMixin, - MarketApiMixin, - PledgeApiMixin, + LlmCorpusApiMixin, + SpotApiMixin, StockApiMixin, + UnpublishedApiMixin, + UsApiMixin, ) from .base import DEFAULT_BASE_URL, BaseClient, get_base_url, set_base_url class FtshareClient( - CorporateApiMixin, - EconomicApiMixin, + StockApiMixin, + HkApiMixin, + UsApiMixin, + IndexApiMixin, EtfApiMixin, - FinanceApiMixin, FundApiMixin, FuturesApiMixin, - GlobalIndexApiMixin, - GoodwillApiMixin, - HkApiMixin, - HolderApiMixin, - IndexApiMixin, - MarketApiMixin, - PledgeApiMixin, - StockApiMixin, + BondApiMixin, + EconomicApiMixin, + LlmCorpusApiMixin, + SpotApiMixin, + ForexApiMixin, + UnpublishedApiMixin, BaseClient, ): """Synchronous client for all documented FTShare data endpoints. - The class combines small business-domain mixins while keeping one public + The class combines ftshare-doc topic mixins while keeping one public client surface. Users should continue to construct it via ``ftshare.market_api``. """ diff --git a/src/ftshare/config.py b/src/ftshare/config.py index 299c2db..b68c371 100644 --- a/src/ftshare/config.py +++ b/src/ftshare/config.py @@ -2,7 +2,7 @@ from __future__ import annotations -DEFAULT_BASE_URL = "https://market.ft.tech/data/" +DEFAULT_BASE_URL = "https://market.ft.tech/gateway/" """Default FTShare API base URL.""" DEFAULT_MAX_PAGE_SIZE = 200 @@ -15,8 +15,8 @@ def normalize_base_url(url: str) -> str: """Normalize a base URL to the canonical trailing-slash form. Args: - url: API base URL. Both ``https://host/data`` and - ``https://host/data/`` are accepted. + url: API base URL. Both ``https://host/gateway`` and + ``https://host/gateway/`` are accepted. Returns: The normalized base URL, always ending with ``/``. diff --git a/src/ftshare/endpoints.py b/src/ftshare/endpoints.py deleted file mode 100644 index 2b71503..0000000 --- a/src/ftshare/endpoints.py +++ /dev/null @@ -1,1960 +0,0 @@ -"""Endpoint registry for FTShare market data.""" - -from __future__ import annotations - -from dataclasses import dataclass - - -@dataclass(frozen=True) -class Endpoint: - """Metadata for a single FTShare API endpoint.""" - - name: str - path: str | None - method: str = "GET" - title: str = "" - doc_file: str | None = None - original_api: str = "" - params: tuple[str, ...] = () - path_params: tuple[str, ...] = () - max_page_size: int = 200 - - -ENDPOINTS: dict[str, Endpoint] = { - 'abnormal_trading_details': Endpoint( - name='abnormal_trading_details', - path='api/v1/market/data/abnormal-trading-details', - method='GET', - title='龙虎榜明细', - doc_file='龙虎榜明细.md', - original_api='abnormal_trading_details', - params=('date',), - path_params=(), - max_page_size=200, - ), - 'abnormal_trading_overview': Endpoint( - name='abnormal_trading_overview', - path='api/v1/market/data/abnormal-trading-overview', - method='GET', - title='龙虎榜总览', - doc_file='龙虎榜总览.md', - original_api='abnormal_trading_overview', - params=('date',), - path_params=(), - max_page_size=200, - ), - 'auction_results': Endpoint( - name='auction_results', - path='api/v1/market/data/auction-results', - method='GET', - title='集合竞价结果', - doc_file='集合竞价结果.md', - original_api='auction_results', - params=('ts_code', 'trade_date', 'start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'baidu_financial_calendar': Endpoint( - name='baidu_financial_calendar', - path='api/v1/market/data/finance/financial-calendar/baidu', - method='GET', - title='百度财经日历', - doc_file='百度财经日历.md', - original_api='baidu_financial_calendar', - params=('start_date', 'end_date', 'category', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'balance': Endpoint( - name='balance', - path='api/v1/market/data/finance/balance', - method='GET', - title='A股资产负债表', - doc_file='A股资产负债表.md', - original_api='balance', - params=('stock_code', 'year', 'report_type', 'page', 'page_size'), - path_params=(), - max_page_size=500, - ), - 'block_trades': Endpoint( - name='block_trades', - path='api/v1/market/data/block-trades', - method='GET', - title='大宗交易', - doc_file='大宗交易.md', - original_api='block_trades', - params=('date',), - path_params=(), - max_page_size=200, - ), - 'bse_mapping': Endpoint( - name='bse_mapping', - path='api/v1/market/data/bse-mapping', - method='GET', - title='北交所映射', - doc_file='北交所映射.md', - original_api='get_bse_mapping', - params=('o_code', 'n_code'), - path_params=(), - max_page_size=200, - ), - 'bullion_price': Endpoint( - name='bullion_price', - path='api/v1/market/data/bullion/price', - method='GET', - title='贵金属价格', - doc_file='贵金属价格.md', - original_api='get_bullion_price', - params=('symbol', 'start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'bullion_support_symbol': Endpoint( - name='bullion_support_symbol', - path='api/v1/market/data/bullion/support-symbol', - method='GET', - title='贵金属支持标的', - doc_file='贵金属支持标的.md', - original_api='get_bullion_support_symbol', - params=(), - path_params=(), - max_page_size=200, - ), - 'cashflow': Endpoint( - name='cashflow', - path='api/v1/market/data/finance/cashflow', - method='GET', - title='A股现金流量表', - doc_file='A股现金流量表.md', - original_api='cashflow', - params=('stock_code', 'year', 'report_type', 'page', 'page_size'), - path_params=(), - max_page_size=500, - ), - 'cashflow_stock_code': Endpoint( - name='cashflow_stock_code', - path='api/v1/market/data/finance/cashflow-stock-code', - method='GET', - title='现金流支持股票代码', - doc_file='现金流支持股票代码.md', - original_api='get_cashflow_stock_code', - params=(), - path_params=(), - max_page_size=200, - ), - 'cb_base_data': Endpoint( - name='cb_base_data', - path='api/v1/market/data/cb/cb-base-data', - method='GET', - title='可转债基础数据', - doc_file='可转债基础数据.md', - original_api='get_cb_base_data_handler', - params=('symbol_code',), - path_params=(), - max_page_size=200, - ), - 'cb_lists': Endpoint( - name='cb_lists', - path='api/v1/market/data/cb/cb-lists', - method='GET', - title='可转债列表', - doc_file='可转债列表.md', - original_api='get_cb_lists_handler', - params=(), - path_params=(), - max_page_size=200, - ), - 'china_futures_base_data': Endpoint( - name='china_futures_base_data', - path='api/v1/market/data/futures/futures-base-data', - method='GET', - title='中国期货基础数据', - doc_file='中国期货基础数据.md', - original_api='get_china_futures_base_data_handler', - params=('trade_date', 'symbol'), - path_params=(), - max_page_size=200, - ), - 'china_futures_lists': Endpoint( - name='china_futures_lists', - path='api/v1/market/data/futures/futures-lists', - method='GET', - title='中国期货列表', - doc_file='中国期货列表.md', - original_api='get_china_futures_lists_handler', - params=('trade_date',), - path_params=(), - max_page_size=200, - ), - 'company_hk': Endpoint( - name='company_hk', - path='api/v1/market/data/hk/company-hk', - method='GET', - title='港股公司信息', - doc_file='港股公司信息.md', - original_api='get_company_hk', - params=('trade_code',), - path_params=(), - max_page_size=200, - ), - 'company_list': Endpoint( - name='company_list', - path='api/v1/market/data/company-list', - method='GET', - title='公司列表', - doc_file='公司列表.md', - original_api='get_company_list', - params=('stock_name', 'stock_code', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'consumer_credit_monthly': Endpoint( - name='consumer_credit_monthly', - path='api/v1/market/data/economic/china-credit-loans', - method='GET', - title='社融信贷', - doc_file='社融信贷.md', - original_api='consumer_credit_monthly', - params=(), - path_params=(), - max_page_size=200, - ), - 'consumer_customs_trade_monthly': Endpoint( - name='consumer_customs_trade_monthly', - path='api/v1/market/data/economic/china-customs-trade', - method='GET', - title='进出口', - doc_file='进出口.md', - original_api='consumer_customs_trade_monthly', - params=(), - path_params=(), - max_page_size=200, - ), - 'consumer_fiscal_revenue_monthly': Endpoint( - name='consumer_fiscal_revenue_monthly', - path='api/v1/market/data/economic/china-fiscal-revenue', - method='GET', - title='财政收入', - doc_file='财政收入.md', - original_api='consumer_fiscal_revenue_monthly', - params=(), - path_params=(), - max_page_size=200, - ), - 'consumer_fixed_asset_monthly': Endpoint( - name='consumer_fixed_asset_monthly', - path='api/v1/market/data/economic/china-fixed-asset-investment', - method='GET', - title='固定资产投资', - doc_file='固定资产投资.md', - original_api='consumer_fixed_asset_monthly', - params=(), - path_params=(), - max_page_size=200, - ), - 'consumer_forex_gold_monthly': Endpoint( - name='consumer_forex_gold_monthly', - path='api/v1/market/data/economic/china-forex-gold', - method='GET', - title='外汇黄金', - doc_file='外汇黄金.md', - original_api='consumer_forex_gold_monthly', - params=(), - path_params=(), - max_page_size=200, - ), - 'consumer_gdp_quarterly': Endpoint( - name='consumer_gdp_quarterly', - path='api/v1/market/data/economic/china-gdp', - method='GET', - title='GDP', - doc_file='GDP.md', - original_api='consumer_gdp_quarterly', - params=(), - path_params=(), - max_page_size=200, - ), - 'consumer_industrial_added_value_monthly': Endpoint( - name='consumer_industrial_added_value_monthly', - path='api/v1/market/data/economic/china-industrial-added-value', - method='GET', - title='工业增加值', - doc_file='工业增加值.md', - original_api='consumer_industrial_added_value_monthly', - params=(), - path_params=(), - max_page_size=200, - ), - 'consumer_money_supply_monthly': Endpoint( - name='consumer_money_supply_monthly', - path='api/v1/market/data/economic/china-money-supply', - method='GET', - title='货币供应', - doc_file='货币供应.md', - original_api='consumer_money_supply_monthly', - params=(), - path_params=(), - max_page_size=200, - ), - 'consumer_pmi_monthly': Endpoint( - name='consumer_pmi_monthly', - path='api/v1/market/data/economic/china-pmi', - method='GET', - title='PMI', - doc_file='PMI.md', - original_api='consumer_pmi_monthly', - params=(), - path_params=(), - max_page_size=200, - ), - 'consumer_ppi_monthly': Endpoint( - name='consumer_ppi_monthly', - path='api/v1/market/data/economic/china-ppi', - method='GET', - title='PPI', - doc_file='PPI.md', - original_api='consumer_ppi_monthly', - params=(), - path_params=(), - max_page_size=200, - ), - 'consumer_price_index_monthly': Endpoint( - name='consumer_price_index_monthly', - path='api/v1/market/data/economic/china-cpi', - method='GET', - title='CPI', - doc_file='CPI.md', - original_api='consumer_price_index_monthly', - params=(), - path_params=(), - max_page_size=200, - ), - 'consumer_retail_sales_monthly': Endpoint( - name='consumer_retail_sales_monthly', - path='api/v1/market/data/economic/china-retail-sales', - method='GET', - title='社零', - doc_file='社零.md', - original_api='consumer_retail_sales_monthly', - params=(), - path_params=(), - max_page_size=200, - ), - 'earnings_reports_paginated': Endpoint( - name='earnings_reports_paginated', - path='api/v1/market/data/finance/stock-performance-express', - method='GET', - title='业绩快报', - doc_file='业绩快报.md', - original_api='earnings_reports_paginated', - params=('stock_code', 'year', 'report_type', 'page', 'page_size'), - path_params=(), - max_page_size=500, - ), - 'eastmoney_board_constituents': Endpoint( - name='eastmoney_board_constituents', - path='api/v1/market/data/eastmoney-board-constituents', - method='GET', - title='东方财富板块成份股', - doc_file='东方财富板块成份股.md', - original_api='eastmoney_board_constituents', - params=('board_code',), - path_params=(), - max_page_size=200, - ), - 'eastmoney_board_daily_kline': Endpoint( - name='eastmoney_board_daily_kline', - path='api/v1/market/data/eastmoney-board-daily-ohlc', - method='GET', - title='东方财富板块日线OHLC', - doc_file='东方财富板块日线OHLC.md', - original_api='eastmoney_board_daily_kline', - params=('board_code', 'start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'eastmoney_board_latest_kline': Endpoint( - name='eastmoney_board_latest_kline', - path='api/v1/market/data/eastmoney-board-latest-ohlc', - method='GET', - title='东方财富板块最新OHLC', - doc_file='东方财富板块最新OHLC.md', - original_api='eastmoney_board_latest_kline', - params=('board_code', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'eastmoney_concept_boards': Endpoint( - name='eastmoney_concept_boards', - path='api/v1/market/data/eastmoney-concept-boards', - method='GET', - title='东方财富概念板块', - doc_file='东方财富概念板块.md', - original_api='eastmoney_concept_boards', - params=(), - path_params=(), - max_page_size=200, - ), - 'eastmoney_dapan_flow': Endpoint( - name='eastmoney_dapan_flow', - path='api/v1/market/data/eastmoney-dapan-flow', - method='GET', - title='东方财富大盘资金流', - doc_file='东方财富大盘资金流.md', - original_api='get_eastmoney_dapan_flow', - params=('trade_date', 'start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'eastmoney_futures_position': Endpoint( - name='eastmoney_futures_position', - path='api/v1/market/data/eastmoney-futures-position', - method='GET', - title='东方财富期货持仓', - doc_file='东方财富期货持仓.md', - original_api='get_eastmoney_futures_position', - params=('exchange', 'variety_code', 'contract_code', 'trade_date', 'start_date', 'end_date', 'member_name_abbr', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'eastmoney_hk_index_daily_kline': Endpoint( - name='eastmoney_hk_index_daily_kline', - path='api/v1/market/data/eastmoney-hk-index-daily-kline', - method='GET', - title='东方财富港股指数日K', - doc_file='东方财富港股指数日K.md', - original_api='get_eastmoney_hk_index_daily_kline', - params=('index_code', 'trade_date', 'start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'eastmoney_market_valuation': Endpoint( - name='eastmoney_market_valuation', - path='api/v1/market/data/eastmoney-market-valuation', - method='GET', - title='东方财富市场估值', - doc_file='东方财富市场估值.md', - original_api='get_eastmoney_market_valuation', - params=('market_code', 'trade_date', 'start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'eastmoney_rank': Endpoint( - name='eastmoney_rank', - path='api/v1/market/data/eastmoney-rank', - method='GET', - title='东方财富股票排名', - doc_file='东方财富股票排名.md', - original_api='eastmoney_rank', - params=('rank_group', 'market', 'trade_date'), - path_params=(), - max_page_size=200, - ), - 'eastmoney_sector_flow': Endpoint( - name='eastmoney_sector_flow', - path='api/v1/market/data/eastmoney-sector-flow', - method='GET', - title='东方财富板块资金流', - doc_file='东方财富板块资金流.md', - original_api='get_eastmoney_sector_flow', - params=('sector_code', 'sector_type', 'trade_date', 'start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'eastmoney_stock_flow': Endpoint( - name='eastmoney_stock_flow', - path='api/v1/market/data/eastmoney-stock-flow', - method='GET', - title='东方财富个股资金流', - doc_file='东方财富个股资金流.md', - original_api='get_eastmoney_stock_flow', - params=('symbol', 'trade_date', 'start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'eastmoney_stock_valuation': Endpoint( - name='eastmoney_stock_valuation', - path='api/v1/market/data/eastmoney-stock-valuation', - method='GET', - title='东方财富个股估值', - doc_file='东方财富个股估值.md', - original_api='get_eastmoney_stock_valuation', - params=('symbol', 'trade_date', 'start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'eastmoney_us_stock_daily_kline': Endpoint( - name='eastmoney_us_stock_daily_kline', - path='api/v1/market/data/eastmoney-us-stock-daily-ohlc', - method='GET', - title='东方财富美股日OHLC', - doc_file='东方财富美股日OHLC.md', - original_api='eastmoney_us_stock_daily_kline', - params=('stock_code', 'start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'eastmoney_us_stock_latest_kline': Endpoint( - name='eastmoney_us_stock_latest_kline', - path='api/v1/market/data/eastmoney-us-stock-latest-ohlc', - method='GET', - title='东方财富美股最新OHLC', - doc_file='东方财富美股最新OHLC.md', - original_api='eastmoney_us_stock_latest_kline', - params=('stock_code', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'eastmoney_us_stock_list': Endpoint( - name='eastmoney_us_stock_list', - path='api/v1/market/data/eastmoney-us-stock-list', - method='GET', - title='东方财富美股列表', - doc_file='东方财富美股列表.md', - original_api='eastmoney_us_stock_list', - params=('refresh', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'etf_adjust_factor': Endpoint( - name='etf_adjust_factor', - path='api/v1/market/data/etf-adjust-factor', - method='GET', - title='ETF复权因子', - doc_file='ETF复权因子.md', - original_api='etf_adjust_factor', - params=('symbol', 'trade_date', 'start_date', 'end_date', 'offset', 'limit'), - path_params=(), - max_page_size=200, - ), - 'etf_components': Endpoint( - name='etf_components', - path='api/v1/market/data/etf-component', - method='GET', - title='ETF成份股', - doc_file='ETF成份股.md', - original_api='get_etf_components_handler', - params=('symbol',), - path_params=(), - max_page_size=200, - ), - 'etf_components_all': Endpoint( - name='etf_components_all', - path='api/v1/market/data/etf-components-all', - method='GET', - title='ETF成份列表', - doc_file='ETF成份列表.md', - original_api='etf_components_all', - params=(), - path_params=(), - max_page_size=200, - ), - 'etf_description_all': Endpoint( - name='etf_description_all', - path='api/v1/market/data/etf-description-all', - method='GET', - title='ETF基础信息', - doc_file='ETF基础信息.md', - original_api='etf_description_all', - params=(), - path_params=(), - max_page_size=200, - ), - 'etf_fund_export': Endpoint( - name='etf_fund_export', - path='api/v1/market/data/etf/zhitou-etf', - method='GET', - title='指数ETF基金导出', - doc_file='指数ETF基金导出.md', - original_api='etf_fund_export', - params=('request_id', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'etf_pcf_list': Endpoint( - name='etf_pcf_list', - path='api/v1/market/data/etf-pcf/etf-pcfs', - method='GET', - title='ETF-PCF清单列表', - doc_file='ETF-PCF清单列表.md', - original_api='etf_pcf_list_handler', - params=('date', 'page', 'page_size'), - path_params=(), - max_page_size=100, - ), - 'etf_pre': Endpoint( - name='etf_pre', - path='api/v1/market/data/etf-pre-data', - method='GET', - title='ETF盘前数据', - doc_file='ETF盘前数据.md', - original_api='get_etf_pre', - params=('date',), - path_params=(), - max_page_size=200, - ), - 'etf_pre_single': Endpoint( - name='etf_pre_single', - path='api/v1/market/data/etf-pre-single', - method='GET', - title='单只ETF盘前数据', - doc_file='单只ETF盘前数据.md', - original_api='get_etf_pre_single_handler', - params=('symbol', 'date'), - path_params=(), - max_page_size=200, - ), - 'fund_basicinfo': Endpoint( - name='fund_basicinfo', - path='api/v1/market/data/fund/fund-basicinfo', - method='GET', - title='基金基础信息', - doc_file='基金基础信息.md', - original_api='get_fund_basicinfo', - params=('institution_code', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'fund_cal_return': Endpoint( - name='fund_cal_return', - path='api/v1/market/data/fund/fund-cal-return', - method='GET', - title='基金收益', - doc_file='基金收益.md', - original_api='get_fund_cal_return', - params=('institution_code', 'cal-type'), - path_params=(), - max_page_size=200, - ), - 'fund_nav': Endpoint( - name='fund_nav', - path='api/v1/market/data/fund/fund-nav', - method='GET', - title='基金净值', - doc_file='基金净值.md', - original_api='get_fund_nav', - params=('institution_code', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'fund_overview': Endpoint( - name='fund_overview', - path='api/v1/market/data/fund/fund-overview', - method='GET', - title='基金总览', - doc_file='基金总览.md', - original_api='get_fund_overview', - params=('page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'fund_support_symbols': Endpoint( - name='fund_support_symbols', - path='api/v1/market/data/fund/fund-support-symbols', - method='GET', - title='基金支持标的', - doc_file='基金支持标的.md', - original_api='get_fund_support_symbols', - params=('page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'futures_contract_kline': Endpoint( - name='futures_contract_kline', - path='api/v1/market/data/futures/kline', - method='GET', - title='期货合约K线', - doc_file='期货合约K线.md', - original_api='futures_contract_kline', - params=('symbol', 'interval', 'start', 'end', 'limit'), - path_params=(), - max_page_size=200, - ), - 'global_index_daily_kline': Endpoint( - name='global_index_daily_kline', - path='api/v1/market/data/global-index/daily-kline', - method='GET', - title='全球指数日K线', - doc_file='全球指数日K线.md', - original_api='global_index_daily_kline', - params=('secid', 'start_date', 'end_date'), - path_params=(), - max_page_size=200, - ), - 'goodwill_industry': Endpoint( - name='goodwill_industry', - path='api/v1/market/data/goodwill/industry', - method='GET', - title='商誉行业', - doc_file='商誉行业.md', - original_api='goodwill_industry', - params=('date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'goodwill_market_overview': Endpoint( - name='goodwill_market_overview', - path='api/v1/market/data/goodwill/market-overview', - method='GET', - title='商誉市场总览', - doc_file='商誉市场总览.md', - original_api='goodwill_market_overview', - params=(), - path_params=(), - max_page_size=200, - ), - 'goodwill_predict': Endpoint( - name='goodwill_predict', - path='api/v1/market/data/goodwill/predict', - method='GET', - title='商誉预测', - doc_file='商誉预测.md', - original_api='goodwill_predict', - params=('date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'goodwill_stock_detail': Endpoint( - name='goodwill_stock_detail', - path='api/v1/market/data/goodwill/stock-detail', - method='GET', - title='商誉个股明细', - doc_file='商誉个股明细.md', - original_api='goodwill_stock_detail', - params=('date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'goodwill_stock_impairment': Endpoint( - name='goodwill_stock_impairment', - path='api/v1/market/data/goodwill/stock-impairment', - method='GET', - title='商誉减值', - doc_file='商誉减值.md', - original_api='goodwill_stock_impairment', - params=('date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'hk_balance_bank': Endpoint( - name='hk_balance_bank', - path='api/v1/market/data/hk/hk-balance-bank', - method='GET', - title='港股资产负债表', - doc_file='港股资产负债表.md', - original_api='hk_balance_bank', - params=('trade_code', 'year', 'report_type', 'start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'hk_balance_gene': Endpoint( - name='hk_balance_gene', - path='api/v1/market/data/hk/hk-balance-gene', - method='GET', - title='港股资产负债表', - doc_file='港股资产负债表.md', - original_api='hk_balance_gene', - params=('trade_code', 'year', 'report_type', 'start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'hk_balance_insur': Endpoint( - name='hk_balance_insur', - path='api/v1/market/data/hk/hk-balance-insur', - method='GET', - title='港股资产负债表', - doc_file='港股资产负债表.md', - original_api='hk_balance_insur', - params=('trade_code', 'year', 'report_type', 'start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'hk_basinfo_get': Endpoint( - name='hk_basinfo_get', - path='api/v1/market/data/hk/hk-view', - method='GET', - title='港股个股信息', - doc_file='港股个股信息.md', - original_api='get_hk_basinfo_get', - params=('hk_code',), - path_params=(), - max_page_size=200, - ), - 'hk_basinfo_post': Endpoint( - name='hk_basinfo_post', - path='api/v1/market/data/hk/hk-view', - method='GET', - title='港股个股信息', - doc_file='港股个股信息.md', - original_api='get_hk_basinfo_post', - params=('hk_code',), - path_params=(), - max_page_size=200, - ), - 'hk_candlesticks': Endpoint( - name='hk_candlesticks', - path='api/v1/market/data/hk/hk-candlesticks', - method='GET', - title='港股K线', - doc_file='港股K线.md', - original_api='get_hk_candlesticks', - params=('trade_code', 'interval_unit', 'until_date', 'since_date', 'interval_value', 'limit', 'adjust_kind'), - path_params=(), - max_page_size=200, - ), - 'hk_cashflow': Endpoint( - name='hk_cashflow', - path='api/v1/market/data/hk/hk-cashflow', - method='GET', - title='港股现金流量表', - doc_file='港股现金流量表.md', - original_api='hk_cashflow', - params=('stock_code', 'year', 'report_type', 'start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'hk_income_bank': Endpoint( - name='hk_income_bank', - path='api/v1/market/data/hk/hk-income-bank', - method='GET', - title='港股利润表', - doc_file='港股利润表.md', - original_api='hk_income_bank', - params=('trade_code', 'year', 'report_type', 'start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'hk_income_gene': Endpoint( - name='hk_income_gene', - path='api/v1/market/data/hk/hk-income-gene', - method='GET', - title='港股利润表', - doc_file='港股利润表.md', - original_api='hk_income_gene', - params=('trade_code', 'year', 'report_type', 'start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'hk_income_insur': Endpoint( - name='hk_income_insur', - path='api/v1/market/data/hk/hk-income-insur', - method='GET', - title='港股利润表', - doc_file='港股利润表.md', - original_api='hk_income_insur', - params=('trade_code', 'year', 'report_type', 'start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'hk_sh_stock_connect_members': Endpoint( - name='hk_sh_stock_connect_members', - path='api/v1/market/data/hk-sh-stock-connect-members', - method='GET', - title='沪港通成份', - doc_file='沪港通成份.md', - original_api='hk_sh_stock_connect_members', - params=(), - path_params=(), - max_page_size=200, - ), - 'hk_sz_stock_connect_members': Endpoint( - name='hk_sz_stock_connect_members', - path='api/v1/market/data/hk-sz-stock-connect-members', - method='GET', - title='深港通成份', - doc_file='深港通成份.md', - original_api='hk_sz_stock_connect_members', - params=(), - path_params=(), - max_page_size=200, - ), - 'hk_valuatnanalyd': Endpoint( - name='hk_valuatnanalyd', - path='api/v1/market/data/hk/hk-valuatnanalyd', - method='GET', - title='港股估值分析', - doc_file='港股估值分析.md', - original_api='get_hk_valuatnanalyd', - params=('trade_code', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'income': Endpoint( - name='income', - path='api/v1/market/data/finance/income', - method='GET', - title='A股利润表', - doc_file='A股利润表.md', - original_api='income', - params=('stock_code', 'year', 'report_type', 'page', 'page_size'), - path_params=(), - max_page_size=500, - ), - 'index_description_all': Endpoint( - name='index_description_all', - path='api/v1/market/data/index-description-all', - method='GET', - title='指数基础信息', - doc_file='指数基础信息.md', - original_api='index_description_all', - params=(), - path_params=(), - max_page_size=200, - ), - 'index_description_list': Endpoint( - name='index_description_list', - path='api/v1/market/data/index/index_description', - method='GET', - title='中证指数描述列表', - doc_file='中证指数描述列表.md', - original_api='index_description_list_handler', - params=('page', 'page_size'), - path_params=(), - max_page_size=100, - ), - 'index_weight_list': Endpoint( - name='index_weight_list', - path='api/v1/market/data/index/index_weight', - method='GET', - title='指数权重列表', - doc_file='指数权重列表.md', - original_api='index_weight_list_handler', - params=('index_code', 'date', 'page', 'page_size'), - path_params=(), - max_page_size=100, - ), - 'index_weight_summary': Endpoint( - name='index_weight_summary', - path='api/v1/market/data/index/index_weight_summary', - method='GET', - title='指数权重汇总', - doc_file='指数权重汇总.md', - original_api='index_weight_summary_handler', - params=('page', 'page_size'), - path_params=(), - max_page_size=100, - ), - 'limit_down_pool': Endpoint( - name='limit_down_pool', - path='api/v1/market/data/limit-down-pool', - method='GET', - title='跌停池', - doc_file='跌停池.md', - original_api='limit_down_pool', - params=(), - path_params=(), - max_page_size=200, - ), - 'limit_event_timeline_3s': Endpoint( - name='limit_event_timeline_3s', - path='api/v1/market/data/limit-event-timeline-3s', - method='GET', - title='涨跌停事件时间线', - doc_file='涨跌停事件时间线.md', - original_api='limit_event_timeline_3s', - params=('symbol',), - path_params=(), - max_page_size=200, - ), - 'limit_up_break_pool': Endpoint( - name='limit_up_break_pool', - path='api/v1/market/data/limit-up-break-pool', - method='GET', - title='炸板池', - doc_file='炸板池.md', - original_api='limit_up_break_pool', - params=(), - path_params=(), - max_page_size=200, - ), - 'limit_up_pool': Endpoint( - name='limit_up_pool', - path='api/v1/market/data/limit-up-pool', - method='GET', - title='涨停池', - doc_file='涨停池.md', - original_api='limit_up_pool', - params=(), - path_params=(), - max_page_size=200, - ), - 'limit_up_pool_yesterday': Endpoint( - name='limit_up_pool_yesterday', - path='api/v1/market/data/limit-up-pool-yesterday', - method='GET', - title='昨日涨停池', - doc_file='昨日涨停池.md', - original_api='limit_up_pool_yesterday', - params=(), - path_params=(), - max_page_size=200, - ), - 'lpr_monthly': Endpoint( - name='lpr_monthly', - path='api/v1/market/data/economic/china-lpr', - method='GET', - title='LPR', - doc_file='LPR.md', - original_api='lpr_monthly', - params=(), - path_params=(), - max_page_size=200, - ), - 'major_contract': Endpoint( - name='major_contract', - path='api/v1/market/data/corporate/contract', - method='GET', - title='重大合同', - doc_file='重大合同.md', - original_api='major_contract', - params=('start_date', 'end_date'), - path_params=(), - max_page_size=3, - ), - 'major_contract_by_symbol': Endpoint( - name='major_contract_by_symbol', - path='api/v1/market/data/corporate/contract/by-symbol', - method='GET', - title='重大合同按标的', - doc_file='重大合同按标的.md', - original_api='major_contract_by_symbol', - params=('symbol', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'major_contract_summary': Endpoint( - name='major_contract_summary', - path='api/v1/market/data/corporate/contract/summary', - method='GET', - title='重大合同汇总', - doc_file='重大合同汇总.md', - original_api='major_contract_summary', - params=('page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'margin_trading_details': Endpoint( - name='margin_trading_details', - path='api/v1/market/data/margin-trading-details', - method='GET', - title='融资融券明细', - doc_file='融资融券明细.md', - original_api='margin_trading_details', - params=('date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'margin_trading_details_paginated': Endpoint( - name='margin_trading_details_paginated', - path='api/v1/market/data/margin-trading-details', - method='GET', - title='融资融券明细分页', - doc_file='融资融券明细分页.md', - original_api='margin_trading_details_paginated', - params=('date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'market_cap_hk': Endpoint( - name='market_cap_hk', - path='api/v1/market/data/hk/market-cap-hk', - method='GET', - title='港股市值', - doc_file='港股市值.md', - original_api='get_market_cap_hk', - params=('trade_code',), - path_params=(), - max_page_size=200, - ), - 'northbound': Endpoint( - name='northbound', - path='api/v1/market/data/northbound', - method='GET', - title='北向资金交易', - doc_file='北向资金交易.md', - original_api='northbound', - params=('date',), - path_params=(), - max_page_size=200, - ), - 'nth_trade_date': Endpoint( - name='nth_trade_date', - path='api/v1/market/data/time/get-nth-trade-date', - method='GET', - title='第N个交易日', - doc_file='第N个交易日.md', - original_api='get_nth_trade_date', - params=('n',), - path_params=(), - max_page_size=200, - ), - 'performance_forecasts_paginated': Endpoint( - name='performance_forecasts_paginated', - path='api/v1/market/data/finance/stock-performance-forecast', - method='GET', - title='业绩预告', - doc_file='业绩预告.md', - original_api='performance_forecasts_paginated', - params=('stock_code', 'year', 'report_type', 'page', 'page_size'), - path_params=(), - max_page_size=500, - ), - 'price_change': Endpoint( - name='price_change', - path='api/v1/market/data/price/get-price-change', - method='GET', - title='价格变动', - doc_file='价格变动.md', - original_api='get_price_change', - params=('stock_code', 'base_date', 'n', 'direction'), - path_params=(), - max_page_size=200, - ), - 'reserve_ratio_monthly': Endpoint( - name='reserve_ratio_monthly', - path='api/v1/market/data/economic/china-reserve-ratio', - method='GET', - title='存款准备金率', - doc_file='存款准备金率.md', - original_api='reserve_ratio_monthly', - params=(), - path_params=(), - max_page_size=200, - ), - 'risk_warning_stock_quotes': Endpoint( - name='risk_warning_stock_quotes', - path='api/v1/market/data/risk-warning-stocks/quotes', - method='GET', - title='风险警示股行情', - doc_file='风险警示股行情.md', - original_api='risk_warning_stock_quotes', - params=('date',), - path_params=(), - max_page_size=200, - ), - 'risk_warning_stocks': Endpoint( - name='risk_warning_stocks', - path='api/v1/market/data/risk-warning-stocks', - method='GET', - title='风险警示股', - doc_file='风险警示股.md', - original_api='risk_warning_stocks', - params=('date',), - path_params=(), - max_page_size=200, - ), - 'search': Endpoint( - name='search', - path='api/v1/market/security/search', - method='GET', - title='标的搜索', - doc_file='标的搜索.md', - original_api='search', - params=('query', 'limit'), - path_params=(), - max_page_size=200, - ), - 'semantic_search_news': Endpoint( - name='semantic_search_news', - path='api/v1/market/data/semantic-search-news', - method='GET', - title='新闻语义搜索', - doc_file='新闻语义搜索.md', - original_api='semantic_search_news_handler', - params=('query', 'limit', 'year', 'start_time', 'end_time'), - path_params=(), - max_page_size=200, - ), - 'sh_hk_stock_connect_members': Endpoint( - name='sh_hk_stock_connect_members', - path='api/v1/market/data/sh-hk-stock-connect-members', - method='GET', - title='沪股通成份', - doc_file='沪股通成份.md', - original_api='sh_hk_stock_connect_members', - params=(), - path_params=(), - max_page_size=200, - ), - 'shareholders_meeting': Endpoint( - name='shareholders_meeting', - path='api/v1/market/data/corporate/meeting', - method='GET', - title='股东大会', - doc_file='股东大会.md', - original_api='shareholders_meeting', - params=('page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'southbound': Endpoint( - name='southbound', - path='api/v1/market/data/southbound', - method='GET', - title='南向资金交易', - doc_file='南向资金交易.md', - original_api='southbound', - params=('date',), - path_params=(), - max_page_size=200, - ), - 'stk_ah_comparison': Endpoint( - name='stk_ah_comparison', - path='api/v1/market/data/hk/stk-ah-comparison', - method='GET', - title='AH股对比', - doc_file='AH股对比.md', - original_api='get_stk_ah_comparison', - params=('hk_code', 'ts_code', 'trade_date', 'start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=1000, - ), - 'stk_limit': Endpoint( - name='stk_limit', - path='api/v1/market/data/stk-limit', - method='GET', - title='涨跌停价', - doc_file='涨跌停价.md', - original_api='stk_limit', - params=('instrument_type', 'symbol', 'symbol_id', 'market_id', 'trade_date', 'start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=500, - ), - 'stk_premarket': Endpoint( - name='stk_premarket', - path='api/v1/market/data/stk-premarket', - method='GET', - title='盘前数据', - doc_file='盘前数据.md', - original_api='stk_premarket', - params=('ts_code', 'trade_date', 'start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=500, - ), - 'stock_adjust_factor': Endpoint( - name='stock_adjust_factor', - path='api/v1/market/data/stock-adjust-factor', - method='GET', - title='股票复权因子', - doc_file='股票复权因子.md', - original_api='stock_adjust_factor', - params=('symbol', 'trade_date', 'start_date', 'end_date', 'offset', 'limit'), - path_params=(), - max_page_size=200, - ), - 'stock_announcements': Endpoint( - name='stock_announcements', - path='api/v1/market/data/announcements/stock-announcements', - method='GET', - title='公告列表', - doc_file='公告列表.md', - original_api='stock_announcements', - params=('stock_code', 'start_date', 'end_date', 'type', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'stock_candlesticks': Endpoint( - name='stock_candlesticks', - path='api/v1/market/data/stock-candlesticks', - method='POST', - title='股票K线', - doc_file='股票K线.md', - original_api='stock_candlesticks', - params=('symbol', 'interval_unit', 'interval_value', 'adjust_kind', 'since_ts_millis', 'until_ts_millis', 'limit'), - path_params=(), - max_page_size=200, - ), - 'stock_candlesticks_batch': Endpoint( - name='stock_candlesticks_batch', - path='api/v1/market/data/stock-candlesticks/batch', - method='POST', - title='批量股票K线', - doc_file='批量股票K线.md', - original_api='stock_candlesticks_batch', - params=('symbols', 'interval_unit', 'interval_value', 'adjust_kind', 'since_ts_millis', 'until_ts_millis', 'limit'), - path_params=(), - max_page_size=200, - ), - 'stock_capital_flows_paginated': Endpoint( - name='stock_capital_flows_paginated', - path='api/v1/market/data/stock-capital-flows', - method='GET', - title='股票资金流向', - doc_file='股票资金流向.md', - original_api='stock_capital_flows_paginated', - params=('date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'stock_comment_desire_em': Endpoint( - name='stock_comment_desire_em', - path='api/v1/market/data/stock-comment/desire', - method='GET', - title='千股千评意愿度', - doc_file='千股千评意愿度.md', - original_api='stock_comment_desire_em', - params=('symbol',), - path_params=(), - max_page_size=200, - ), - 'stock_comment_em': Endpoint( - name='stock_comment_em', - path='api/v1/market/data/stock-comment/index', - method='GET', - title='千股千评', - doc_file='千股千评.md', - original_api='stock_comment_em', - params=('page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'stock_comment_focus_em': Endpoint( - name='stock_comment_focus_em', - path='api/v1/market/data/stock-comment/focus', - method='GET', - title='千股千评关注度', - doc_file='千股千评关注度.md', - original_api='stock_comment_focus_em', - params=('symbol',), - path_params=(), - max_page_size=200, - ), - 'stock_comment_org_participate_em': Endpoint( - name='stock_comment_org_participate_em', - path='api/v1/market/data/stock-comment/org-participate', - method='GET', - title='机构参与度', - doc_file='机构参与度.md', - original_api='stock_comment_org_participate_em', - params=('symbol',), - path_params=(), - max_page_size=200, - ), - 'stock_comment_score_em': Endpoint( - name='stock_comment_score_em', - path='api/v1/market/data/stock-comment/score', - method='GET', - title='千股千评评分', - doc_file='千股千评评分.md', - original_api='stock_comment_score_em', - params=('symbol',), - path_params=(), - max_page_size=200, - ), - 'stock_dividends_paginated': Endpoint( - name='stock_dividends_paginated', - path='api/v1/market/data/dividends', - method='GET', - title='股票分红记录分页', - doc_file='股票分红记录分页.md', - original_api='stock_dividends_paginated', - params=('page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'stock_filter': Endpoint( - name='stock_filter', - path='api/v1/market/data/stock-list/filter', - method='GET', - title='股票筛选', - doc_file='股票筛选.md', - original_api='stock_filter', - params=('board', 'listing_date_since', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'stock_float_holders': Endpoint( - name='stock_float_holders', - path='api/v1/market/data/holder/stock-holder-ften', - method='GET', - title='十大流通股东', - doc_file='十大流通股东.md', - original_api='stock_float_holders', - params=('stock_code', 'is_last', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'stock_ggcg_em': Endpoint( - name='stock_ggcg_em', - path='api/v1/market/data/holder/stock-ggcg-em', - method='GET', - title='东方财富股东增减持', - doc_file='东方财富股东增减持.md', - original_api='stock_ggcg_em_handler', - params=('symbol', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'stock_ggmx': Endpoint( - name='stock_ggmx', - path='api/v1/market/data/holder/stock-ggmx', - method='GET', - title='董监高持股变动', - doc_file='董监高持股变动.md', - original_api='stock_ggmx_handler', - params=('stock_code', 'change_direction', 'start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'stock_ggmx_buy_ranking': Endpoint( - name='stock_ggmx_buy_ranking', - path='api/v1/market/data/holder/stock-ggmx-buy-ranking', - method='GET', - title='董监高增持排名', - doc_file='董监高增持排名.md', - original_api='stock_ggmx_buy_ranking_handler', - params=('time_range', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'stock_ggmx_sell_ranking': Endpoint( - name='stock_ggmx_sell_ranking', - path='api/v1/market/data/holder/stock-ggmx-sell-ranking', - method='GET', - title='董监高减持排名', - doc_file='董监高减持排名.md', - original_api='stock_ggmx_sell_ranking_handler', - params=('time_range', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'stock_holders': Endpoint( - name='stock_holders', - path='api/v1/market/data/holder/stock-holder-ten', - method='GET', - title='十大股东', - doc_file='十大股东.md', - original_api='stock_holders', - params=('stock_code', 'is_last', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'stock_holders_number': Endpoint( - name='stock_holders_number', - path='api/v1/market/data/holder/stock-holder-nums', - method='GET', - title='股东人数', - doc_file='股东人数.md', - original_api='stock_holders_number', - params=('stock_code', 'is_last', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'stock_institution_holdings': Endpoint( - name='stock_institution_holdings', - path='api/v1/market/data/share/stock-institution-holdings', - method='GET', - title='机构持股', - doc_file='机构持股.md', - original_api='get_stock_institution_holdings', - params=('year', 'report_type', 'inst_type', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'stock_institution_holdings_detail': Endpoint( - name='stock_institution_holdings_detail', - path='api/v1/market/data/share/stock-institution-holdings-detail', - method='GET', - title='机构持股明细', - doc_file='机构持股明细.md', - original_api='get_stock_institution_holdings_detail', - params=('stock_code', 'year', 'report_type', 'inst_type', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'stock_institution_share_holdings': Endpoint( - name='stock_institution_share_holdings', - path='api/v1/market/data/institution/institution-share-holdings', - method='GET', - title='机构股本持股', - doc_file='机构股本持股.md', - original_api='get_stock_institution_share_holdings', - params=('institution_id', 'year', 'report_type', 'invest_type'), - path_params=(), - max_page_size=200, - ), - 'stock_intraday': Endpoint( - name='stock_intraday', - path='api/v1/market/security/{symbol}/intraday', - method='GET', - title='股票日内分时', - doc_file='股票日内分时.md', - original_api='stock_intraday', - params=('symbol',), - path_params=('symbol',), - max_page_size=200, - ), - 'stock_intraday_auction_volume': Endpoint( - name='stock_intraday_auction_volume', - path='api/v1/market/data/intraday-auction-volume', - method='GET', - title='集合竞价成交量', - doc_file='集合竞价成交量.md', - original_api='stock_intraday_auction_volume', - params=('trade_date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'stock_intraday_auction_volume_symbol': Endpoint( - name='stock_intraday_auction_volume_symbol', - path='api/v1/market/data/intraday-auction-volume/symbol', - method='GET', - title='单标的集合竞价成交量', - doc_file='单标的集合竞价成交量.md', - original_api='stock_intraday_auction_volume_symbol', - params=('symbol', 'trade_date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'stock_ipos': Endpoint( - name='stock_ipos', - path='api/v1/market/data/stock-ipos', - method='GET', - title='股票IPO', - doc_file='股票IPO.md', - original_api='stock_ipos', - params=('page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'stock_ipos_paginated': Endpoint( - name='stock_ipos_paginated', - path='api/v1/market/data/stock-ipos', - method='GET', - title='股票IPO分页', - doc_file='股票IPO分页.md', - original_api='stock_ipos_paginated', - params=('page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'stock_list': Endpoint( - name='stock_list', - path='api/v1/market/data/stock-list', - method='GET', - title='股票列表', - doc_file='股票列表.md', - original_api='get_stock_list', - params=(), - path_params=(), - max_page_size=200, - ), - 'stock_market': Endpoint( - name='stock_market', - path='api/v1/market/data/daec/market/snapshot', - method='GET', - title='股票市场行情', - doc_file='股票市场行情.md', - original_api='stock_market', - params=('scope',), - path_params=(), - max_page_size=200, - ), - 'stock_market_distribution_intraday': Endpoint( - name='stock_market_distribution_intraday', - path='api/v1/market/data/daec/market/distribution-history', - method='GET', - title='市场涨跌分布分时', - doc_file='市场涨跌分布分时.md', - original_api='stock_market_distribution_intraday', - params=('scope',), - path_params=(), - max_page_size=200, - ), - 'stock_pledge_detail': Endpoint( - name='stock_pledge_detail', - path='api/v1/market/data/pledge/pledge-detail', - method='GET', - title='股权质押明细', - doc_file='股权质押明细.md', - original_api='stock_pledge_detail', - params=('stock_code', 'is_last', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'stock_pledge_summary': Endpoint( - name='stock_pledge_summary', - path='api/v1/market/data/pledge/pledge-summary', - method='GET', - title='股权质押汇总', - doc_file='股权质押汇总.md', - original_api='stock_pledge_summary', - params=('page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'stock_prev_close': Endpoint( - name='stock_prev_close', - path='api/v1/market/data/daec/history/prev-closes', - method='GET', - title='股票前收盘价', - doc_file='股票前收盘价.md', - original_api='stock_prev_close', - params=('symbol', 'since', 'until'), - path_params=(), - max_page_size=200, - ), - 'stock_rating_top5': Endpoint( - name='stock_rating_top5', - path='api/v1/market/data/feitu/stock-rating-top5', - method='GET', - title='飞兔股票评级Top5', - doc_file='飞兔股票评级Top5.md', - original_api='stock_rating_top5', - params=('date', 'variant', 'type'), - path_params=(), - max_page_size=200, - ), - 'stock_related': Endpoint( - name='stock_related', - path='api/v1/market/security/{symbol}/related', - method='GET', - title='相关股票', - doc_file='相关股票.md', - original_api='stock_related', - params=('symbol', 'limit'), - path_params=('symbol',), - max_page_size=200, - ), - 'stock_reports': Endpoint( - name='stock_reports', - path='api/v1/market/data/report/stock-reports', - method='GET', - title='研报列表', - doc_file='研报列表.md', - original_api='stock_reports', - params=('stock_code', 'start_date', 'end_date', 'type', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'stock_share': Endpoint( - name='stock_share', - path='api/v1/market/data/share/get-stock-share', - method='GET', - title='股本', - doc_file='股本.md', - original_api='get_stock_share_handler', - params=('stock_code', 'date'), - path_params=(), - max_page_size=200, - ), - 'stock_share_chg': Endpoint( - name='stock_share_chg', - path='api/v1/market/data/holder/stock-share-chg', - method='GET', - title='股东增减持', - doc_file='股东增减持.md', - original_api='stock_share_chg', - params=('stock_code', 'is_last', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'stock_signal_latest_snapshot': Endpoint( - name='stock_signal_latest_snapshot', - path='api/v1/market/data/stock-signal-latest-snapshot', - method='GET', - title='信号最新快照', - doc_file='信号最新快照.md', - original_api='stock_signal_latest_snapshot', - params=('signal_type', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'stock_trade': Endpoint( - name='stock_trade', - path='api/v1/market/data/daec/history/trades', - method='GET', - title='股票分时成交', - doc_file='股票分时成交.md', - original_api='stock_trade', - params=('symbol',), - path_params=(), - max_page_size=200, - ), - 'stock_unlock': Endpoint( - name='stock_unlock', - path='api/v1/market/data/unlock/stock-unlock', - method='GET', - title='限售解禁', - doc_file='限售解禁.md', - original_api='stock_unlock_handler', - params=('stock_code', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'stock_unlock_by_date': Endpoint( - name='stock_unlock_by_date', - path='api/v1/market/data/unlock/stock-unlock-by-date', - method='GET', - title='限售解禁按日期', - doc_file='限售解禁按日期.md', - original_api='stock_unlock_by_date_handler', - params=('start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'suspension_list': Endpoint( - name='suspension_list', - path='api/v1/market/data/suspension-list', - method='GET', - title='停牌列表', - doc_file='停牌列表.md', - original_api='suspension_list', - params=('trade_date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'sw_industry_constituent_history': Endpoint( - name='sw_industry_constituent_history', - path='api/v1/market/data/sw-industry/constituent-history', - method='GET', - title='申万行业成份股历史', - doc_file='申万行业成份股历史.md', - original_api='sw_industry_constituent_history', - params=('industry_code',), - path_params=(), - max_page_size=200, - ), - 'sw_industry_daily_metrics': Endpoint( - name='sw_industry_daily_metrics', - path='api/v1/market/data/sw-industry/daily-metrics', - method='GET', - title='申万行业日度指标', - doc_file='申万行业日度指标.md', - original_api='sw_industry_daily_metrics', - params=('level', 'start_date', 'end_date', 'industry_code', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'sw_industry_overview': Endpoint( - name='sw_industry_overview', - path='api/v1/market/data/sw-industry/overview', - method='GET', - title='申万行业总览', - doc_file='申万行业总览.md', - original_api='sw_industry_overview', - params=('date', 'level', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'sz_hk_stock_connect_members': Endpoint( - name='sz_hk_stock_connect_members', - path='api/v1/market/data/sz-hk-stock-connect-members', - method='GET', - title='深股通成份', - doc_file='深股通成份.md', - original_api='sz_hk_stock_connect_members', - params=(), - path_params=(), - max_page_size=200, - ), - 'tax_revenue_monthly': Endpoint( - name='tax_revenue_monthly', - path='api/v1/market/data/economic/china-tax-revenue', - method='GET', - title='税收', - doc_file='税收.md', - original_api='tax_revenue_monthly', - params=(), - path_params=(), - max_page_size=200, - ), - 'ths_all_board_kline': Endpoint( - name='ths_all_board_kline', - path='api/v1/market/data/ths-all-board-kline', - method='GET', - title='同花顺全板块K线', - doc_file='同花顺全板块K线.md', - original_api='ths_all_board_kline', - params=('start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'ths_board_kline': Endpoint( - name='ths_board_kline', - path='api/v1/market/data/ths-board-kline', - method='GET', - title='同花顺板块K线', - doc_file='同花顺板块K线.md', - original_api='ths_board_kline', - params=('board_code', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'ths_board_list': Endpoint( - name='ths_board_list', - path='api/v1/market/data/ths-board-list', - method='GET', - title='同花顺板块列表', - doc_file='同花顺板块列表.md', - original_api='ths_board_list', - params=(), - path_params=(), - max_page_size=200, - ), - 'type_reports': Endpoint( - name='type_reports', - path='api/v1/market/data/report/type-reports', - method='GET', - title='研报分类', - doc_file='研报分类.md', - original_api='type_reports', - params=('rept_type', 'start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'us_balance': Endpoint( - name='us_balance', - path='api/v1/market/data/us/us-balance', - method='GET', - title='美股资产负债表', - doc_file='美股资产负债表.md', - original_api='us_balance', - params=('stock_code', 'period', 'report_type', 'start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=500, - ), - 'us_basic': Endpoint( - name='us_basic', - path='api/v1/market/data/us/us-basic', - method='GET', - title='美股基础信息', - doc_file='美股基础信息.md', - original_api='us_basic', - params=('stock_code', 'page', 'page_size'), - path_params=(), - max_page_size=500, - ), - 'us_cashflow': Endpoint( - name='us_cashflow', - path='api/v1/market/data/us/us-cashflow', - method='GET', - title='美股现金流', - doc_file='美股现金流.md', - original_api='us_cashflow', - params=('stock_code', 'period', 'report_type', 'start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=500, - ), - 'us_economic': Endpoint( - name='us_economic', - path='api/v1/market/data/economic/us-economic', - method='GET', - title='美国经济指标', - doc_file='美国经济指标.md', - original_api='us_economic', - params=('type',), - path_params=(), - max_page_size=200, - ), - 'us_income': Endpoint( - name='us_income', - path='api/v1/market/data/us/us-income', - method='GET', - title='美股利润表', - doc_file='美股利润表.md', - original_api='us_income', - params=('stock_code', 'period', 'report_type', 'start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=500, - ), - 'wallstreetcn_financial_calendar': Endpoint( - name='wallstreetcn_financial_calendar', - path='api/v1/market/data/finance/financial-calendar/wallstreetcn', - method='GET', - title='华尔街见闻财经日历', - doc_file='华尔街见闻财经日历.md', - original_api='wallstreetcn_financial_calendar', - params=('start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'xueqiu_rank': Endpoint( - name='xueqiu_rank', - path='api/v1/market/data/xueqiu-rank', - method='GET', - title='雪球股票排名', - doc_file='雪球股票排名.md', - original_api='xueqiu_rank', - params=('rank_group', 'period', 'trade_date', 'page', 'page_size'), - path_params=(), - max_page_size=100, - ), - 'yzxdr_detail': Endpoint( - name='yzxdr_detail', - path='api/v1/market/data/yzxdr-detail', - method='GET', - title='除权除息明细', - doc_file='除权除息明细.md', - original_api='get_yzxdr_detail', - params=('year', 'quarter', 'stock_code', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'eastmoney_futures_strange': Endpoint( - name='eastmoney_futures_strange', - path='api/v1/market/data/eastmoney-futures-position', - method='GET', - title='东方财富期货持仓', - doc_file='东方财富期货持仓.md', - original_api='get_eastmoney_futures_position', - params=('exchange', 'variety_code', 'contract_code', 'trade_date', 'start_date', 'end_date', 'member_name_abbr', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'eastmoney_us_stock_daily_ohlc': Endpoint( - name='eastmoney_us_stock_daily_ohlc', - path='api/v1/market/data/eastmoney-us-stock-daily-ohlc', - method='GET', - title='东方财富美股日OHLC', - doc_file='东方财富美股日OHLC.md', - original_api='eastmoney_us_stock_daily_kline', - params=('stock_code', 'start_date', 'end_date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'eastmoney_us_stock_latest_ohlc': Endpoint( - name='eastmoney_us_stock_latest_ohlc', - path='api/v1/market/data/eastmoney-us-stock-latest-ohlc', - method='GET', - title='东方财富美股最新OHLC', - doc_file='东方财富美股最新OHLC.md', - original_api='eastmoney_us_stock_latest_kline', - params=('stock_code', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'futures_kline': Endpoint( - name='futures_kline', - path='api/v1/market/data/futures/kline', - method='GET', - title='期货合约K线', - doc_file='期货合约K线.md', - original_api='futures_contract_kline', - params=('symbol', 'interval', 'start', 'end', 'limit'), - path_params=(), - max_page_size=200, - ), - 'pledge_summary': Endpoint( - name='pledge_summary', - path='api/v1/market/data/pledge/pledge-summary', - method='GET', - title='股权质押汇总', - doc_file='股权质押汇总.md', - original_api='stock_pledge_summary', - params=('page', 'page_size'), - path_params=(), - max_page_size=200, - ), - 'stock_capital_flows': Endpoint( - name='stock_capital_flows', - path='api/v1/market/data/stock-capital-flows', - method='GET', - title='股票资金流向', - doc_file='股票资金流向.md', - original_api='stock_capital_flows_paginated', - params=('date', 'page', 'page_size'), - path_params=(), - max_page_size=200, - ), -} diff --git a/src/ftshare/endpoints/__init__.py b/src/ftshare/endpoints/__init__.py new file mode 100644 index 0000000..9b2ff27 --- /dev/null +++ b/src/ftshare/endpoints/__init__.py @@ -0,0 +1,37 @@ +"""Endpoint registry assembled from ftshare-doc topic modules.""" + +from __future__ import annotations + +from .types import Endpoint +from .stock import ENDPOINTS as STOCK_ENDPOINTS +from .hk import ENDPOINTS as HK_ENDPOINTS +from .us import ENDPOINTS as US_ENDPOINTS +from .index import ENDPOINTS as INDEX_ENDPOINTS +from .etf import ENDPOINTS as ETF_ENDPOINTS +from .fund import ENDPOINTS as FUND_ENDPOINTS +from .futures import ENDPOINTS as FUTURES_ENDPOINTS +from .bond import ENDPOINTS as BOND_ENDPOINTS +from .economic import ENDPOINTS as ECONOMIC_ENDPOINTS +from .llm_corpus import ENDPOINTS as LLM_CORPUS_ENDPOINTS +from .spot import ENDPOINTS as SPOT_ENDPOINTS +from .forex import ENDPOINTS as FOREX_ENDPOINTS +from .unpublished import ENDPOINTS as UNPUBLISHED_ENDPOINTS + + +ENDPOINTS: dict[str, Endpoint] = {} +ENDPOINTS.update(STOCK_ENDPOINTS) +ENDPOINTS.update(HK_ENDPOINTS) +ENDPOINTS.update(US_ENDPOINTS) +ENDPOINTS.update(INDEX_ENDPOINTS) +ENDPOINTS.update(ETF_ENDPOINTS) +ENDPOINTS.update(FUND_ENDPOINTS) +ENDPOINTS.update(FUTURES_ENDPOINTS) +ENDPOINTS.update(BOND_ENDPOINTS) +ENDPOINTS.update(ECONOMIC_ENDPOINTS) +ENDPOINTS.update(LLM_CORPUS_ENDPOINTS) +ENDPOINTS.update(SPOT_ENDPOINTS) +ENDPOINTS.update(FOREX_ENDPOINTS) +ENDPOINTS.update(UNPUBLISHED_ENDPOINTS) + + +__all__ = ["ENDPOINTS", "Endpoint"] diff --git a/src/ftshare/endpoints/bond.py b/src/ftshare/endpoints/bond.py new file mode 100644 index 0000000..d292886 --- /dev/null +++ b/src/ftshare/endpoints/bond.py @@ -0,0 +1,22 @@ +"""Bond endpoints generated from ftshare-doc.""" + +from __future__ import annotations + +from .types import Endpoint, build_endpoints + + +ENDPOINTS: dict[str, Endpoint] = build_endpoints({ + 'cb_base_data': { + 'path': 'api/v1/market/data/cb/cb-base-data', + 'title': '可转债基础数据', + 'doc_file': '可转债基础数据.md', + 'original_api': 'get_cb_base_data_handler', + 'params': ('symbol_code',), + }, + 'cb_lists': { + 'path': 'api/v1/market/data/cb/cb-lists', + 'title': '可转债列表', + 'doc_file': '可转债列表.md', + 'original_api': 'get_cb_lists_handler', + }, +}) diff --git a/src/ftshare/endpoints/economic.py b/src/ftshare/endpoints/economic.py new file mode 100644 index 0000000..1202800 --- /dev/null +++ b/src/ftshare/endpoints/economic.py @@ -0,0 +1,114 @@ +"""Economic endpoints generated from ftshare-doc.""" + +from __future__ import annotations + +from .types import Endpoint, build_endpoints + + +ENDPOINTS: dict[str, Endpoint] = build_endpoints({ + 'baidu_financial_calendar': { + 'path': 'api/v1/market/data/finance/financial-calendar/baidu', + 'title': '百度财经日历', + 'doc_file': '百度财经日历.md', + 'original_api': 'baidu_financial_calendar', + 'params': ('start_date', 'end_date', 'category', 'page', 'page_size'), + }, + 'consumer_credit_monthly': { + 'path': 'api/v1/market/data/economic/china-credit-loans', + 'title': '社融信贷', + 'doc_file': '社融信贷.md', + 'original_api': 'consumer_credit_monthly', + }, + 'consumer_customs_trade_monthly': { + 'path': 'api/v1/market/data/economic/china-customs-trade', + 'title': '进出口', + 'doc_file': '进出口.md', + 'original_api': 'consumer_customs_trade_monthly', + }, + 'consumer_fiscal_revenue_monthly': { + 'path': 'api/v1/market/data/economic/china-fiscal-revenue', + 'title': '财政收入', + 'doc_file': '财政收入.md', + 'original_api': 'consumer_fiscal_revenue_monthly', + }, + 'consumer_fixed_asset_monthly': { + 'path': 'api/v1/market/data/economic/china-fixed-asset-investment', + 'title': '固定资产投资', + 'doc_file': '固定资产投资.md', + 'original_api': 'consumer_fixed_asset_monthly', + }, + 'consumer_gdp_quarterly': { + 'path': 'api/v1/market/data/economic/china-gdp', + 'title': 'GDP', + 'doc_file': 'GDP.md', + 'original_api': 'consumer_gdp_quarterly', + }, + 'consumer_industrial_added_value_monthly': { + 'path': 'api/v1/market/data/economic/china-industrial-added-value', + 'title': '工业增加值', + 'doc_file': '工业增加值.md', + 'original_api': 'consumer_industrial_added_value_monthly', + }, + 'consumer_money_supply_monthly': { + 'path': 'api/v1/market/data/economic/china-money-supply', + 'title': '货币供应', + 'doc_file': '货币供应.md', + 'original_api': 'consumer_money_supply_monthly', + }, + 'consumer_pmi_monthly': { + 'path': 'api/v1/market/data/economic/china-pmi', + 'title': 'PMI', + 'doc_file': 'PMI.md', + 'original_api': 'consumer_pmi_monthly', + }, + 'consumer_ppi_monthly': { + 'path': 'api/v1/market/data/economic/china-ppi', + 'title': 'PPI', + 'doc_file': 'PPI.md', + 'original_api': 'consumer_ppi_monthly', + }, + 'consumer_price_index_monthly': { + 'path': 'api/v1/market/data/economic/china-cpi', + 'title': 'CPI', + 'doc_file': 'CPI.md', + 'original_api': 'consumer_price_index_monthly', + }, + 'consumer_retail_sales_monthly': { + 'path': 'api/v1/market/data/economic/china-retail-sales', + 'title': '社零', + 'doc_file': '社零.md', + 'original_api': 'consumer_retail_sales_monthly', + }, + 'lpr_monthly': { + 'path': 'api/v1/market/data/economic/china-lpr', + 'title': 'LPR', + 'doc_file': 'LPR.md', + 'original_api': 'lpr_monthly', + }, + 'reserve_ratio_monthly': { + 'path': 'api/v1/market/data/economic/china-reserve-ratio', + 'title': '存款准备金率', + 'doc_file': '存款准备金率.md', + 'original_api': 'reserve_ratio_monthly', + }, + 'tax_revenue_monthly': { + 'path': 'api/v1/market/data/economic/china-tax-revenue', + 'title': '税收', + 'doc_file': '税收.md', + 'original_api': 'tax_revenue_monthly', + }, + 'us_economic': { + 'path': 'api/v1/market/data/economic/us-economic', + 'title': '美国经济指标', + 'doc_file': '美国经济指标.md', + 'original_api': 'us_economic', + 'params': ('type',), + }, + 'wallstreetcn_financial_calendar': { + 'path': 'api/v1/market/data/finance/financial-calendar/wallstreetcn', + 'title': '华尔街见闻财经日历', + 'doc_file': '华尔街见闻财经日历.md', + 'original_api': 'wallstreetcn_financial_calendar', + 'params': ('start_date', 'end_date', 'page', 'page_size'), + }, +}) diff --git a/src/ftshare/endpoints/etf.py b/src/ftshare/endpoints/etf.py new file mode 100644 index 0000000..b9ac0c7 --- /dev/null +++ b/src/ftshare/endpoints/etf.py @@ -0,0 +1,64 @@ +"""ETF endpoints generated from ftshare-doc.""" + +from __future__ import annotations + +from .types import Endpoint, build_endpoints + + +ENDPOINTS: dict[str, Endpoint] = build_endpoints({ + 'etf_adjust_factor': { + 'path': 'api/v1/market/data/etf-adjust-factor', + 'title': 'ETF复权因子', + 'doc_file': 'ETF复权因子.md', + 'original_api': 'etf_adjust_factor', + 'params': ('symbol', 'trade_date', 'start_date', 'end_date', 'offset', 'limit'), + }, + 'etf_components': { + 'path': 'api/v1/market/data/etf-component', + 'title': 'ETF成份股', + 'doc_file': 'ETF成份股.md', + 'original_api': 'get_etf_components_handler', + 'params': ('symbol',), + }, + 'etf_components_all': { + 'path': 'api/v1/market/data/etf-components-all', + 'title': 'ETF成份列表', + 'doc_file': 'ETF成份列表.md', + 'original_api': 'etf_components_all', + }, + 'etf_description_all': { + 'path': 'api/v1/market/data/etf-description-all', + 'title': 'ETF基础信息', + 'doc_file': 'ETF基础信息.md', + 'original_api': 'etf_description_all', + }, + 'etf_fund_export': { + 'path': 'api/v1/market/data/etf/zhitou-etf', + 'title': '指数ETF基金导出', + 'doc_file': '指数ETF基金导出.md', + 'original_api': 'etf_fund_export', + 'params': ('request_id', 'page', 'page_size'), + }, + 'etf_pcf_list': { + 'path': 'api/v1/market/data/etf-pcf/etf-pcfs', + 'title': 'ETF-PCF清单列表', + 'doc_file': 'ETF-PCF清单列表.md', + 'original_api': 'etf_pcf_list_handler', + 'params': ('date', 'page', 'page_size'), + 'max_page_size': 100, + }, + 'etf_pre': { + 'path': 'api/v1/market/data/etf-pre-data', + 'title': 'ETF盘前数据', + 'doc_file': 'ETF盘前数据.md', + 'original_api': 'get_etf_pre', + 'params': ('date',), + }, + 'etf_pre_single': { + 'path': 'api/v1/market/data/etf-pre-single', + 'title': '单只ETF盘前数据', + 'doc_file': '单只ETF盘前数据.md', + 'original_api': 'get_etf_pre_single_handler', + 'params': ('symbol', 'date'), + }, +}) diff --git a/src/ftshare/endpoints/forex.py b/src/ftshare/endpoints/forex.py new file mode 100644 index 0000000..1c18242 --- /dev/null +++ b/src/ftshare/endpoints/forex.py @@ -0,0 +1,15 @@ +"""Foreign exchange endpoints generated from ftshare-doc.""" + +from __future__ import annotations + +from .types import Endpoint, build_endpoints + + +ENDPOINTS: dict[str, Endpoint] = build_endpoints({ + 'consumer_forex_gold_monthly': { + 'path': 'api/v1/market/data/economic/china-forex-gold', + 'title': '外汇黄金', + 'doc_file': '外汇黄金.md', + 'original_api': 'consumer_forex_gold_monthly', + }, +}) diff --git a/src/ftshare/endpoints/fund.py b/src/ftshare/endpoints/fund.py new file mode 100644 index 0000000..79dcdc6 --- /dev/null +++ b/src/ftshare/endpoints/fund.py @@ -0,0 +1,44 @@ +"""Public fund endpoints generated from ftshare-doc.""" + +from __future__ import annotations + +from .types import Endpoint, build_endpoints + + +ENDPOINTS: dict[str, Endpoint] = build_endpoints({ + 'fund_basicinfo': { + 'path': 'api/v1/market/data/fund/fund-basicinfo', + 'title': '基金基础信息', + 'doc_file': '基金基础信息.md', + 'original_api': 'get_fund_basicinfo', + 'params': ('institution_code', 'page', 'page_size'), + }, + 'fund_cal_return': { + 'path': 'api/v1/market/data/fund/fund-cal-return', + 'title': '基金收益', + 'doc_file': '基金收益.md', + 'original_api': 'get_fund_cal_return', + 'params': ('institution_code', 'cal-type'), + }, + 'fund_nav': { + 'path': 'api/v1/market/data/fund/fund-nav', + 'title': '基金净值', + 'doc_file': '基金净值.md', + 'original_api': 'get_fund_nav', + 'params': ('institution_code', 'page', 'page_size'), + }, + 'fund_overview': { + 'path': 'api/v1/market/data/fund/fund-overview', + 'title': '基金总览', + 'doc_file': '基金总览.md', + 'original_api': 'get_fund_overview', + 'params': ('page', 'page_size'), + }, + 'fund_support_symbols': { + 'path': 'api/v1/market/data/fund/fund-support-symbols', + 'title': '基金支持标的', + 'doc_file': '基金支持标的.md', + 'original_api': 'get_fund_support_symbols', + 'params': ('page', 'page_size'), + }, +}) diff --git a/src/ftshare/endpoints/futures.py b/src/ftshare/endpoints/futures.py new file mode 100644 index 0000000..19ebc8c --- /dev/null +++ b/src/ftshare/endpoints/futures.py @@ -0,0 +1,73 @@ +"""Futures endpoints generated from ftshare-doc.""" + +from __future__ import annotations + +from .types import Endpoint, build_endpoints + + +ENDPOINTS: dict[str, Endpoint] = build_endpoints({ + 'china_futures_base_data': { + 'path': 'api/v1/market/data/futures/futures-base-data', + 'title': '中国期货基础数据', + 'doc_file': '中国期货基础数据.md', + 'original_api': 'get_china_futures_base_data_handler', + 'params': ('trade_date', 'symbol'), + }, + 'china_futures_lists': { + 'path': 'api/v1/market/data/futures/futures-lists', + 'title': '中国期货列表', + 'doc_file': '中国期货列表.md', + 'original_api': 'get_china_futures_lists_handler', + 'params': ('trade_date',), + }, + 'eastmoney_futures_position': { + 'path': 'api/v1/market/data/eastmoney-futures-position', + 'title': '东方财富期货持仓', + 'doc_file': '东方财富期货持仓.md', + 'original_api': 'get_eastmoney_futures_position', + 'params': ('exchange', 'variety_code', 'contract_code', 'trade_date', 'start_date', 'end_date', 'member_name_abbr', 'page', 'page_size'), + }, + 'futures_contract_kline': { + 'path': 'api/v1/market/data/futures/kline', + 'title': '期货合约K线', + 'doc_file': '期货合约K线.md', + 'original_api': 'futures_contract_kline', + 'params': ('symbol', 'interval', 'start', 'end', 'limit'), + }, + 'major_contract': { + 'path': 'api/v1/market/data/corporate/contract', + 'title': '重大合同', + 'doc_file': '重大合同.md', + 'original_api': 'major_contract', + 'params': ('start_date', 'end_date'), + 'max_page_size': 3, + }, + 'major_contract_by_symbol': { + 'path': 'api/v1/market/data/corporate/contract/by-symbol', + 'title': '重大合同按标的', + 'doc_file': '重大合同按标的.md', + 'original_api': 'major_contract_by_symbol', + 'params': ('symbol', 'page', 'page_size'), + }, + 'major_contract_summary': { + 'path': 'api/v1/market/data/corporate/contract/summary', + 'title': '重大合同汇总', + 'doc_file': '重大合同汇总.md', + 'original_api': 'major_contract_summary', + 'params': ('page', 'page_size'), + }, + 'eastmoney_futures_strange': { + 'path': 'api/v1/market/data/eastmoney-futures-position', + 'title': '东方财富期货持仓', + 'doc_file': '东方财富期货持仓.md', + 'original_api': 'get_eastmoney_futures_position', + 'params': ('exchange', 'variety_code', 'contract_code', 'trade_date', 'start_date', 'end_date', 'member_name_abbr', 'page', 'page_size'), + }, + 'futures_kline': { + 'path': 'api/v1/market/data/futures/kline', + 'title': '期货合约K线', + 'doc_file': '期货合约K线.md', + 'original_api': 'futures_contract_kline', + 'params': ('symbol', 'interval', 'start', 'end', 'limit'), + }, +}) diff --git a/src/ftshare/endpoints/hk.py b/src/ftshare/endpoints/hk.py new file mode 100644 index 0000000..2c2b981 --- /dev/null +++ b/src/ftshare/endpoints/hk.py @@ -0,0 +1,107 @@ +"""Hong Kong market endpoints generated from ftshare-doc.""" + +from __future__ import annotations + +from .types import Endpoint, build_endpoints + + +ENDPOINTS: dict[str, Endpoint] = build_endpoints({ + 'company_hk': { + 'path': 'api/v1/market/data/hk/company-hk', + 'title': '港股公司信息', + 'doc_file': '港股公司信息.md', + 'original_api': 'get_company_hk', + 'params': ('trade_code',), + }, + 'eastmoney_hk_index_daily_kline': { + 'path': 'api/v1/market/data/eastmoney-hk-index-daily-kline', + 'title': '东方财富港股指数日K', + 'doc_file': '东方财富港股指数日K.md', + 'original_api': 'get_eastmoney_hk_index_daily_kline', + 'params': ('index_code', 'trade_date', 'start_date', 'end_date', 'page', 'page_size'), + }, + 'hk_balance_bank': { + 'path': 'api/v1/market/data/hk/hk-balance-bank', + 'title': '港股资产负债表', + 'doc_file': '港股资产负债表.md', + 'original_api': 'hk_balance_bank', + 'params': ('trade_code', 'year', 'report_type', 'start_date', 'end_date', 'page', 'page_size'), + }, + 'hk_balance_gene': { + 'path': 'api/v1/market/data/hk/hk-balance-gene', + 'title': '港股资产负债表', + 'doc_file': '港股资产负债表.md', + 'original_api': 'hk_balance_gene', + 'params': ('trade_code', 'year', 'report_type', 'start_date', 'end_date', 'page', 'page_size'), + }, + 'hk_balance_insur': { + 'path': 'api/v1/market/data/hk/hk-balance-insur', + 'title': '港股资产负债表', + 'doc_file': '港股资产负债表.md', + 'original_api': 'hk_balance_insur', + 'params': ('trade_code', 'year', 'report_type', 'start_date', 'end_date', 'page', 'page_size'), + }, + 'hk_basinfo_get': { + 'path': 'api/v1/market/data/hk/hk-view', + 'title': '港股个股信息', + 'doc_file': '港股个股信息.md', + 'original_api': 'get_hk_basinfo_get', + 'params': ('hk_code',), + }, + 'hk_basinfo_post': { + 'path': 'api/v1/market/data/hk/hk-view', + 'title': '港股个股信息', + 'doc_file': '港股个股信息.md', + 'original_api': 'get_hk_basinfo_post', + 'params': ('hk_code',), + }, + 'hk_candlesticks': { + 'path': 'api/v1/market/data/hk/hk-candlesticks', + 'title': '港股K线', + 'doc_file': '港股K线.md', + 'original_api': 'get_hk_candlesticks', + 'params': ('trade_code', 'interval_unit', 'until_date', 'since_date', 'interval_value', 'limit', 'adjust_kind'), + }, + 'hk_cashflow': { + 'path': 'api/v1/market/data/hk/hk-cashflow', + 'title': '港股现金流量表', + 'doc_file': '港股现金流量表.md', + 'original_api': 'hk_cashflow', + 'params': ('stock_code', 'year', 'report_type', 'start_date', 'end_date', 'page', 'page_size'), + }, + 'hk_income_bank': { + 'path': 'api/v1/market/data/hk/hk-income-bank', + 'title': '港股利润表', + 'doc_file': '港股利润表.md', + 'original_api': 'hk_income_bank', + 'params': ('trade_code', 'year', 'report_type', 'start_date', 'end_date', 'page', 'page_size'), + }, + 'hk_income_gene': { + 'path': 'api/v1/market/data/hk/hk-income-gene', + 'title': '港股利润表', + 'doc_file': '港股利润表.md', + 'original_api': 'hk_income_gene', + 'params': ('trade_code', 'year', 'report_type', 'start_date', 'end_date', 'page', 'page_size'), + }, + 'hk_income_insur': { + 'path': 'api/v1/market/data/hk/hk-income-insur', + 'title': '港股利润表', + 'doc_file': '港股利润表.md', + 'original_api': 'hk_income_insur', + 'params': ('trade_code', 'year', 'report_type', 'start_date', 'end_date', 'page', 'page_size'), + }, + 'hk_valuatnanalyd': { + 'path': 'api/v1/market/data/hk/hk-valuatnanalyd', + 'title': '港股估值分析', + 'doc_file': '港股估值分析.md', + 'original_api': 'get_hk_valuatnanalyd', + 'params': ('trade_code', 'page', 'page_size'), + }, + 'market_cap_hk': { + 'path': 'api/v1/market/data/hk/market-cap-hk', + 'title': '港股市值', + 'doc_file': '港股市值.md', + 'original_api': 'get_market_cap_hk', + 'params': ('trade_code',), + }, +}) diff --git a/src/ftshare/endpoints/index.py b/src/ftshare/endpoints/index.py new file mode 100644 index 0000000..3773329 --- /dev/null +++ b/src/ftshare/endpoints/index.py @@ -0,0 +1,67 @@ +"""Index endpoints generated from ftshare-doc.""" + +from __future__ import annotations + +from .types import Endpoint, build_endpoints + + +ENDPOINTS: dict[str, Endpoint] = build_endpoints({ + 'global_index_daily_kline': { + 'path': 'api/v1/market/data/global-index/daily-kline', + 'title': '全球指数日K线', + 'doc_file': '全球指数日K线.md', + 'original_api': 'global_index_daily_kline', + 'params': ('secid', 'start_date', 'end_date'), + }, + 'index_description_all': { + 'path': 'api/v1/market/data/index-description-all', + 'title': '指数基础信息', + 'doc_file': '指数基础信息.md', + 'original_api': 'index_description_all', + }, + 'index_description_list': { + 'path': 'api/v1/market/data/index/index_description', + 'title': '中证指数描述列表', + 'doc_file': '中证指数描述列表.md', + 'original_api': 'index_description_list_handler', + 'params': ('page', 'page_size'), + 'max_page_size': 100, + }, + 'index_weight_list': { + 'path': 'api/v1/market/data/index/index_weight', + 'title': '指数权重列表', + 'doc_file': '指数权重列表.md', + 'original_api': 'index_weight_list_handler', + 'params': ('index_code', 'date', 'page', 'page_size'), + 'max_page_size': 100, + }, + 'index_weight_summary': { + 'path': 'api/v1/market/data/index/index_weight_summary', + 'title': '指数权重汇总', + 'doc_file': '指数权重汇总.md', + 'original_api': 'index_weight_summary_handler', + 'params': ('page', 'page_size'), + 'max_page_size': 100, + }, + 'sw_industry_constituent_history': { + 'path': 'api/v1/market/data/sw-industry/constituent-history', + 'title': '申万行业成份股历史', + 'doc_file': '申万行业成份股历史.md', + 'original_api': 'sw_industry_constituent_history', + 'params': ('industry_code',), + }, + 'sw_industry_daily_metrics': { + 'path': 'api/v1/market/data/sw-industry/daily-metrics', + 'title': '申万行业日度指标', + 'doc_file': '申万行业日度指标.md', + 'original_api': 'sw_industry_daily_metrics', + 'params': ('level', 'start_date', 'end_date', 'industry_code', 'page', 'page_size'), + }, + 'sw_industry_overview': { + 'path': 'api/v1/market/data/sw-industry/overview', + 'title': '申万行业总览', + 'doc_file': '申万行业总览.md', + 'original_api': 'sw_industry_overview', + 'params': ('date', 'level', 'page', 'page_size'), + }, +}) diff --git a/src/ftshare/endpoints/llm_corpus.py b/src/ftshare/endpoints/llm_corpus.py new file mode 100644 index 0000000..e43ec9e --- /dev/null +++ b/src/ftshare/endpoints/llm_corpus.py @@ -0,0 +1,44 @@ +"""LLM corpus endpoints generated from ftshare-doc.""" + +from __future__ import annotations + +from .types import Endpoint, build_endpoints + + +ENDPOINTS: dict[str, Endpoint] = build_endpoints({ + 'semantic_search_news': { + 'path': 'api/v1/market/data/semantic-search-news', + 'title': '新闻语义搜索', + 'doc_file': '新闻语义搜索.md', + 'original_api': 'semantic_search_news_handler', + 'params': ('query', 'limit', 'year', 'start_time', 'end_time'), + }, + 'shareholders_meeting': { + 'path': 'api/v1/market/data/corporate/meeting', + 'title': '股东大会', + 'doc_file': '股东大会.md', + 'original_api': 'shareholders_meeting', + 'params': ('page', 'page_size'), + }, + 'stock_announcements': { + 'path': 'api/v1/market/data/announcements/stock-announcements', + 'title': '公告列表', + 'doc_file': '公告列表.md', + 'original_api': 'stock_announcements', + 'params': ('stock_code', 'start_date', 'end_date', 'type', 'page', 'page_size'), + }, + 'stock_reports': { + 'path': 'api/v1/market/data/report/stock-reports', + 'title': '研报列表', + 'doc_file': '研报列表.md', + 'original_api': 'stock_reports', + 'params': ('stock_code', 'start_date', 'end_date', 'type', 'page', 'page_size'), + }, + 'type_reports': { + 'path': 'api/v1/market/data/report/type-reports', + 'title': '研报分类', + 'doc_file': '研报分类.md', + 'original_api': 'type_reports', + 'params': ('rept_type', 'start_date', 'end_date', 'page', 'page_size'), + }, +}) diff --git a/src/ftshare/endpoints/spot.py b/src/ftshare/endpoints/spot.py new file mode 100644 index 0000000..e481e18 --- /dev/null +++ b/src/ftshare/endpoints/spot.py @@ -0,0 +1,22 @@ +"""Spot commodity endpoints generated from ftshare-doc.""" + +from __future__ import annotations + +from .types import Endpoint, build_endpoints + + +ENDPOINTS: dict[str, Endpoint] = build_endpoints({ + 'bullion_price': { + 'path': 'api/v1/market/data/bullion/price', + 'title': '贵金属价格', + 'doc_file': '贵金属价格.md', + 'original_api': 'get_bullion_price', + 'params': ('symbol', 'start_date', 'end_date', 'page', 'page_size'), + }, + 'bullion_support_symbol': { + 'path': 'api/v1/market/data/bullion/support-symbol', + 'title': '贵金属支持标的', + 'doc_file': '贵金属支持标的.md', + 'original_api': 'get_bullion_support_symbol', + }, +}) diff --git a/src/ftshare/endpoints/stock.py b/src/ftshare/endpoints/stock.py new file mode 100644 index 0000000..31c8b3e --- /dev/null +++ b/src/ftshare/endpoints/stock.py @@ -0,0 +1,674 @@ +"""Stock data endpoints generated from ftshare-doc.""" + +from __future__ import annotations + +from .types import Endpoint, build_endpoints + + +ENDPOINTS: dict[str, Endpoint] = build_endpoints({ + 'abnormal_trading_details': { + 'path': 'api/v1/market/data/abnormal-trading-details', + 'title': '龙虎榜明细', + 'doc_file': '龙虎榜明细.md', + 'original_api': 'abnormal_trading_details', + 'params': ('date',), + }, + 'abnormal_trading_overview': { + 'path': 'api/v1/market/data/abnormal-trading-overview', + 'title': '龙虎榜总览', + 'doc_file': '龙虎榜总览.md', + 'original_api': 'abnormal_trading_overview', + 'params': ('date',), + }, + 'auction_results': { + 'path': 'api/v1/market/data/auction-results', + 'title': '集合竞价结果', + 'doc_file': '集合竞价结果.md', + 'original_api': 'auction_results', + 'params': ('ts_code', 'trade_date', 'start_date', 'end_date', 'page', 'page_size'), + }, + 'balance': { + 'path': 'api/v1/market/data/finance/balance', + 'title': 'A股资产负债表', + 'doc_file': 'A股资产负债表.md', + 'original_api': 'balance', + 'params': ('stock_code', 'year', 'report_type', 'page', 'page_size'), + 'max_page_size': 500, + }, + 'block_trades': { + 'path': 'api/v1/market/data/block-trades', + 'title': '大宗交易', + 'doc_file': '大宗交易.md', + 'original_api': 'block_trades', + 'params': ('date',), + }, + 'bse_mapping': { + 'path': 'api/v1/market/data/bse-mapping', + 'title': '北交所映射', + 'doc_file': '北交所映射.md', + 'original_api': 'get_bse_mapping', + 'params': ('o_code', 'n_code'), + }, + 'cashflow': { + 'path': 'api/v1/market/data/finance/cashflow', + 'title': 'A股现金流量表', + 'doc_file': 'A股现金流量表.md', + 'original_api': 'cashflow', + 'params': ('stock_code', 'year', 'report_type', 'page', 'page_size'), + 'max_page_size': 500, + }, + 'cashflow_stock_code': { + 'path': 'api/v1/market/data/finance/cashflow-stock-code', + 'title': '现金流支持股票代码', + 'doc_file': '现金流支持股票代码.md', + 'original_api': 'get_cashflow_stock_code', + }, + 'company_list': { + 'path': 'api/v1/market/data/company-list', + 'title': '公司列表', + 'doc_file': '公司列表.md', + 'original_api': 'get_company_list', + 'params': ('stock_name', 'stock_code', 'page', 'page_size'), + }, + 'earnings_reports_paginated': { + 'path': 'api/v1/market/data/finance/stock-performance-express', + 'title': '业绩快报', + 'doc_file': '业绩快报.md', + 'original_api': 'earnings_reports_paginated', + 'params': ('stock_code', 'year', 'report_type', 'page', 'page_size'), + 'max_page_size': 500, + }, + 'eastmoney_board_constituents': { + 'path': 'api/v1/market/data/eastmoney-board-constituents', + 'title': '东方财富板块成份股', + 'doc_file': '东方财富板块成份股.md', + 'original_api': 'eastmoney_board_constituents', + 'params': ('board_code',), + }, + 'eastmoney_board_daily_kline': { + 'path': 'api/v1/market/data/eastmoney-board-daily-ohlc', + 'title': '东方财富板块日线OHLC', + 'doc_file': '东方财富板块日线OHLC.md', + 'original_api': 'eastmoney_board_daily_kline', + 'params': ('board_code', 'start_date', 'end_date', 'page', 'page_size'), + }, + 'eastmoney_board_latest_kline': { + 'path': 'api/v1/market/data/eastmoney-board-latest-ohlc', + 'title': '东方财富板块最新OHLC', + 'doc_file': '东方财富板块最新OHLC.md', + 'original_api': 'eastmoney_board_latest_kline', + 'params': ('board_code', 'page', 'page_size'), + }, + 'eastmoney_concept_boards': { + 'path': 'api/v1/market/data/eastmoney-concept-boards', + 'title': '东方财富概念板块', + 'doc_file': '东方财富概念板块.md', + 'original_api': 'eastmoney_concept_boards', + }, + 'eastmoney_dapan_flow': { + 'path': 'api/v1/market/data/eastmoney-dapan-flow', + 'title': '东方财富大盘资金流', + 'doc_file': '东方财富大盘资金流.md', + 'original_api': 'get_eastmoney_dapan_flow', + 'params': ('trade_date', 'start_date', 'end_date', 'page', 'page_size'), + }, + 'eastmoney_market_valuation': { + 'path': 'api/v1/market/data/eastmoney-market-valuation', + 'title': '东方财富市场估值', + 'doc_file': '东方财富市场估值.md', + 'original_api': 'get_eastmoney_market_valuation', + 'params': ('market_code', 'trade_date', 'start_date', 'end_date', 'page', 'page_size'), + }, + 'eastmoney_rank': { + 'path': 'api/v1/market/data/eastmoney-rank', + 'title': '东方财富股票排名', + 'doc_file': '东方财富股票排名.md', + 'original_api': 'eastmoney_rank', + 'params': ('rank_group', 'market', 'trade_date'), + }, + 'eastmoney_sector_flow': { + 'path': 'api/v1/market/data/eastmoney-sector-flow', + 'title': '东方财富板块资金流', + 'doc_file': '东方财富板块资金流.md', + 'original_api': 'get_eastmoney_sector_flow', + 'params': ('sector_code', 'sector_type', 'trade_date', 'start_date', 'end_date', 'page', 'page_size'), + }, + 'eastmoney_stock_flow': { + 'path': 'api/v1/market/data/eastmoney-stock-flow', + 'title': '东方财富个股资金流', + 'doc_file': '东方财富个股资金流.md', + 'original_api': 'get_eastmoney_stock_flow', + 'params': ('symbol', 'trade_date', 'start_date', 'end_date', 'page', 'page_size'), + }, + 'eastmoney_stock_valuation': { + 'path': 'api/v1/market/data/eastmoney-stock-valuation', + 'title': '东方财富个股估值', + 'doc_file': '东方财富个股估值.md', + 'original_api': 'get_eastmoney_stock_valuation', + 'params': ('symbol', 'trade_date', 'start_date', 'end_date', 'page', 'page_size'), + }, + 'goodwill_industry': { + 'path': 'api/v1/market/data/goodwill/industry', + 'title': '商誉行业', + 'doc_file': '商誉行业.md', + 'original_api': 'goodwill_industry', + 'params': ('date', 'page', 'page_size'), + }, + 'goodwill_market_overview': { + 'path': 'api/v1/market/data/goodwill/market-overview', + 'title': '商誉市场总览', + 'doc_file': '商誉市场总览.md', + 'original_api': 'goodwill_market_overview', + }, + 'goodwill_predict': { + 'path': 'api/v1/market/data/goodwill/predict', + 'title': '商誉预测', + 'doc_file': '商誉预测.md', + 'original_api': 'goodwill_predict', + 'params': ('date', 'page', 'page_size'), + }, + 'goodwill_stock_detail': { + 'path': 'api/v1/market/data/goodwill/stock-detail', + 'title': '商誉个股明细', + 'doc_file': '商誉个股明细.md', + 'original_api': 'goodwill_stock_detail', + 'params': ('date', 'page', 'page_size'), + }, + 'goodwill_stock_impairment': { + 'path': 'api/v1/market/data/goodwill/stock-impairment', + 'title': '商誉减值', + 'doc_file': '商誉减值.md', + 'original_api': 'goodwill_stock_impairment', + 'params': ('date', 'page', 'page_size'), + }, + 'hk_sh_stock_connect_members': { + 'path': 'api/v1/market/data/hk-sh-stock-connect-members', + 'title': '沪港通成份', + 'doc_file': '沪港通成份.md', + 'original_api': 'hk_sh_stock_connect_members', + }, + 'hk_sz_stock_connect_members': { + 'path': 'api/v1/market/data/hk-sz-stock-connect-members', + 'title': '深港通成份', + 'doc_file': '深港通成份.md', + 'original_api': 'hk_sz_stock_connect_members', + }, + 'income': { + 'path': 'api/v1/market/data/finance/income', + 'title': 'A股利润表', + 'doc_file': 'A股利润表.md', + 'original_api': 'income', + 'params': ('stock_code', 'year', 'report_type', 'page', 'page_size'), + 'max_page_size': 500, + }, + 'limit_down_pool': { + 'path': 'api/v1/market/data/limit-down-pool', + 'title': '跌停池', + 'doc_file': '跌停池.md', + 'original_api': 'limit_down_pool', + }, + 'limit_event_timeline_3s': { + 'path': 'api/v1/market/data/limit-event-timeline-3s', + 'title': '涨跌停事件时间线', + 'doc_file': '涨跌停事件时间线.md', + 'original_api': 'limit_event_timeline_3s', + 'params': ('symbol',), + }, + 'limit_up_break_pool': { + 'path': 'api/v1/market/data/limit-up-break-pool', + 'title': '炸板池', + 'doc_file': '炸板池.md', + 'original_api': 'limit_up_break_pool', + }, + 'limit_up_pool': { + 'path': 'api/v1/market/data/limit-up-pool', + 'title': '涨停池', + 'doc_file': '涨停池.md', + 'original_api': 'limit_up_pool', + }, + 'limit_up_pool_yesterday': { + 'path': 'api/v1/market/data/limit-up-pool-yesterday', + 'title': '昨日涨停池', + 'doc_file': '昨日涨停池.md', + 'original_api': 'limit_up_pool_yesterday', + }, + 'margin_trading_details': { + 'path': 'api/v1/market/data/margin-trading-details', + 'title': '融资融券明细', + 'doc_file': '融资融券明细.md', + 'original_api': 'margin_trading_details', + 'params': ('date', 'page', 'page_size'), + }, + 'margin_trading_details_paginated': { + 'path': 'api/v1/market/data/margin-trading-details', + 'title': '融资融券明细分页', + 'doc_file': '融资融券明细分页.md', + 'original_api': 'margin_trading_details_paginated', + 'params': ('date', 'page', 'page_size'), + }, + 'northbound': { + 'path': 'api/v1/market/data/northbound', + 'title': '北向资金交易', + 'doc_file': '北向资金交易.md', + 'original_api': 'northbound', + 'params': ('date',), + }, + 'nth_trade_date': { + 'path': 'api/v1/market/data/time/get-nth-trade-date', + 'title': '第N个交易日', + 'doc_file': '第N个交易日.md', + 'original_api': 'get_nth_trade_date', + 'params': ('n',), + }, + 'performance_forecasts_paginated': { + 'path': 'api/v1/market/data/finance/stock-performance-forecast', + 'title': '业绩预告', + 'doc_file': '业绩预告.md', + 'original_api': 'performance_forecasts_paginated', + 'params': ('stock_code', 'year', 'report_type', 'page', 'page_size'), + 'max_page_size': 500, + }, + 'price_change': { + 'path': 'api/v1/market/data/price/get-price-change', + 'title': '价格变动', + 'doc_file': '价格变动.md', + 'original_api': 'get_price_change', + 'params': ('stock_code', 'base_date', 'n', 'direction'), + }, + 'risk_warning_stock_quotes': { + 'path': 'api/v1/market/data/risk-warning-stocks/quotes', + 'title': '风险警示股行情', + 'doc_file': '风险警示股行情.md', + 'original_api': 'risk_warning_stock_quotes', + 'params': ('date',), + }, + 'risk_warning_stocks': { + 'path': 'api/v1/market/data/risk-warning-stocks', + 'title': '风险警示股', + 'doc_file': '风险警示股.md', + 'original_api': 'risk_warning_stocks', + 'params': ('date',), + }, + 'search': { + 'path': 'api/v1/market/security/search', + 'title': '标的搜索', + 'doc_file': '标的搜索.md', + 'original_api': 'search', + 'params': ('query', 'limit'), + }, + 'sh_hk_stock_connect_members': { + 'path': 'api/v1/market/data/sh-hk-stock-connect-members', + 'title': '沪股通成份', + 'doc_file': '沪股通成份.md', + 'original_api': 'sh_hk_stock_connect_members', + }, + 'southbound': { + 'path': 'api/v1/market/data/southbound', + 'title': '南向资金交易', + 'doc_file': '南向资金交易.md', + 'original_api': 'southbound', + 'params': ('date',), + }, + 'stk_ah_comparison': { + 'path': 'api/v1/market/data/hk/stk-ah-comparison', + 'title': 'AH股对比', + 'doc_file': 'AH股对比.md', + 'original_api': 'get_stk_ah_comparison', + 'params': ('hk_code', 'ts_code', 'trade_date', 'start_date', 'end_date', 'page', 'page_size'), + 'max_page_size': 1000, + }, + 'stk_limit': { + 'path': 'api/v1/market/data/stk-limit', + 'title': '涨跌停价', + 'doc_file': '涨跌停价.md', + 'original_api': 'stk_limit', + 'params': ('instrument_type', 'symbol', 'symbol_id', 'market_id', 'trade_date', 'start_date', 'end_date', 'page', 'page_size'), + 'max_page_size': 500, + }, + 'stk_premarket': { + 'path': 'api/v1/market/data/stk-premarket', + 'title': '盘前数据', + 'doc_file': '盘前数据.md', + 'original_api': 'stk_premarket', + 'params': ('ts_code', 'trade_date', 'start_date', 'end_date', 'page', 'page_size'), + 'max_page_size': 500, + }, + 'stock_adjust_factor': { + 'path': 'api/v1/market/data/stock-adjust-factor', + 'title': '股票复权因子', + 'doc_file': '股票复权因子.md', + 'original_api': 'stock_adjust_factor', + 'params': ('symbol', 'trade_date', 'start_date', 'end_date', 'offset', 'limit'), + }, + 'stock_candlesticks': { + 'path': 'api/v1/market/data/stock-candlesticks', + 'title': '股票K线', + 'doc_file': '股票K线.md', + 'original_api': 'stock_candlesticks', + 'method': 'POST', + 'params': ('symbol', 'interval_unit', 'interval_value', 'adjust_kind', 'since_ts_millis', 'until_ts_millis', 'limit'), + }, + 'stock_candlesticks_batch': { + 'path': 'api/v1/market/data/stock-candlesticks/batch', + 'title': '批量股票K线', + 'doc_file': '批量股票K线.md', + 'original_api': 'stock_candlesticks_batch', + 'method': 'POST', + 'params': ('symbols', 'interval_unit', 'interval_value', 'adjust_kind', 'since_ts_millis', 'until_ts_millis', 'limit'), + }, + 'stock_capital_flows_paginated': { + 'path': 'api/v1/market/data/stock-capital-flows', + 'title': '股票资金流向', + 'doc_file': '股票资金流向.md', + 'original_api': 'stock_capital_flows_paginated', + 'params': ('date', 'page', 'page_size'), + }, + 'stock_comment_desire_em': { + 'path': 'api/v1/market/data/stock-comment/desire', + 'title': '千股千评意愿度', + 'doc_file': '千股千评意愿度.md', + 'original_api': 'stock_comment_desire_em', + 'params': ('symbol',), + }, + 'stock_comment_em': { + 'path': 'api/v1/market/data/stock-comment/index', + 'title': '千股千评', + 'doc_file': '千股千评.md', + 'original_api': 'stock_comment_em', + 'params': ('page', 'page_size'), + }, + 'stock_comment_focus_em': { + 'path': 'api/v1/market/data/stock-comment/focus', + 'title': '千股千评关注度', + 'doc_file': '千股千评关注度.md', + 'original_api': 'stock_comment_focus_em', + 'params': ('symbol',), + }, + 'stock_comment_org_participate_em': { + 'path': 'api/v1/market/data/stock-comment/org-participate', + 'title': '机构参与度', + 'doc_file': '机构参与度.md', + 'original_api': 'stock_comment_org_participate_em', + 'params': ('symbol',), + }, + 'stock_comment_score_em': { + 'path': 'api/v1/market/data/stock-comment/score', + 'title': '千股千评评分', + 'doc_file': '千股千评评分.md', + 'original_api': 'stock_comment_score_em', + 'params': ('symbol',), + }, + 'stock_filter': { + 'path': 'api/v1/market/data/stock-list/filter', + 'title': '股票筛选', + 'doc_file': '股票筛选.md', + 'original_api': 'stock_filter', + 'params': ('board', 'listing_date_since', 'page', 'page_size'), + }, + 'stock_float_holders': { + 'path': 'api/v1/market/data/holder/stock-holder-ften', + 'title': '十大流通股东', + 'doc_file': '十大流通股东.md', + 'original_api': 'stock_float_holders', + 'params': ('stock_code', 'is_last', 'page', 'page_size'), + }, + 'stock_ggcg_em': { + 'path': 'api/v1/market/data/holder/stock-ggcg-em', + 'title': '东方财富股东增减持', + 'doc_file': '东方财富股东增减持.md', + 'original_api': 'stock_ggcg_em_handler', + 'params': ('symbol', 'page', 'page_size'), + }, + 'stock_ggmx': { + 'path': 'api/v1/market/data/holder/stock-ggmx', + 'title': '董监高持股变动', + 'doc_file': '董监高持股变动.md', + 'original_api': 'stock_ggmx_handler', + 'params': ('stock_code', 'change_direction', 'start_date', 'end_date', 'page', 'page_size'), + }, + 'stock_ggmx_buy_ranking': { + 'path': 'api/v1/market/data/holder/stock-ggmx-buy-ranking', + 'title': '董监高增持排名', + 'doc_file': '董监高增持排名.md', + 'original_api': 'stock_ggmx_buy_ranking_handler', + 'params': ('time_range', 'page', 'page_size'), + }, + 'stock_ggmx_sell_ranking': { + 'path': 'api/v1/market/data/holder/stock-ggmx-sell-ranking', + 'title': '董监高减持排名', + 'doc_file': '董监高减持排名.md', + 'original_api': 'stock_ggmx_sell_ranking_handler', + 'params': ('time_range', 'page', 'page_size'), + }, + 'stock_holders': { + 'path': 'api/v1/market/data/holder/stock-holder-ten', + 'title': '十大股东', + 'doc_file': '十大股东.md', + 'original_api': 'stock_holders', + 'params': ('stock_code', 'is_last', 'page', 'page_size'), + }, + 'stock_holders_number': { + 'path': 'api/v1/market/data/holder/stock-holder-nums', + 'title': '股东人数', + 'doc_file': '股东人数.md', + 'original_api': 'stock_holders_number', + 'params': ('stock_code', 'is_last', 'page', 'page_size'), + }, + 'stock_institution_holdings': { + 'path': 'api/v1/market/data/share/stock-institution-holdings', + 'title': '机构持股', + 'doc_file': '机构持股.md', + 'original_api': 'get_stock_institution_holdings', + 'params': ('year', 'report_type', 'inst_type', 'page', 'page_size'), + }, + 'stock_institution_holdings_detail': { + 'path': 'api/v1/market/data/share/stock-institution-holdings-detail', + 'title': '机构持股明细', + 'doc_file': '机构持股明细.md', + 'original_api': 'get_stock_institution_holdings_detail', + 'params': ('stock_code', 'year', 'report_type', 'inst_type', 'page', 'page_size'), + }, + 'stock_institution_share_holdings': { + 'path': 'api/v1/market/data/institution/institution-share-holdings', + 'title': '机构股本持股', + 'doc_file': '机构股本持股.md', + 'original_api': 'get_stock_institution_share_holdings', + 'params': ('institution_id', 'year', 'report_type', 'invest_type'), + }, + 'stock_intraday_auction_volume': { + 'path': 'api/v1/market/data/intraday-auction-volume', + 'title': '集合竞价成交量', + 'doc_file': '集合竞价成交量.md', + 'original_api': 'stock_intraday_auction_volume', + 'params': ('trade_date', 'page', 'page_size'), + }, + 'stock_intraday_auction_volume_symbol': { + 'path': 'api/v1/market/data/intraday-auction-volume/symbol', + 'title': '单标的集合竞价成交量', + 'doc_file': '单标的集合竞价成交量.md', + 'original_api': 'stock_intraday_auction_volume_symbol', + 'params': ('symbol', 'trade_date', 'page', 'page_size'), + }, + 'stock_ipos': { + 'path': 'api/v1/market/data/stock-ipos', + 'title': '股票IPO', + 'doc_file': '股票IPO.md', + 'original_api': 'stock_ipos', + 'params': ('page', 'page_size'), + }, + 'stock_list': { + 'path': 'api/v1/market/data/stock-list', + 'title': '股票列表', + 'doc_file': '股票列表.md', + 'original_api': 'get_stock_list', + }, + 'stock_market': { + 'path': 'api/v1/market/data/daec/market/snapshot', + 'title': '市场行情快照', + 'doc_file': '市场行情快照.md', + 'original_api': 'stock_market', + 'params': ('scope',), + }, + 'stock_market_distribution_intraday': { + 'path': 'api/v1/market/data/daec/market/distribution-history', + 'title': '日内涨跌停分布历史', + 'doc_file': '日内涨跌停分布历史.md', + 'original_api': 'stock_market_distribution_intraday', + 'params': ('scope',), + }, + 'stock_daec_stocks': { + 'path': 'api/v1/market/data/daec/stocks/{board}', + 'title': 'A股行情列表', + 'doc_file': 'A股行情列表.md', + 'original_api': 'stock_daec_stocks', + 'params': ('board', 'page', 'page_size', 'filter', 'order_by'), + 'path_params': ('board',), + }, + 'stock_realtime_list': { + 'path': 'api/v1/market/data/stock-list/{board}', + 'title': 'A股行情列表', + 'doc_file': 'A股行情列表.md', + 'original_api': 'stock_realtime_list', + 'params': ('board', 'page', 'page_size'), + 'path_params': ('board',), + }, + 'stock_pledge_detail': { + 'path': 'api/v1/market/data/pledge/pledge-detail', + 'title': '股权质押明细', + 'doc_file': '股权质押明细.md', + 'original_api': 'stock_pledge_detail', + 'params': ('stock_code', 'is_last', 'page', 'page_size'), + }, + 'stock_pledge_summary': { + 'path': 'api/v1/market/data/pledge/pledge-summary', + 'title': '股权质押汇总', + 'doc_file': '股权质押汇总.md', + 'original_api': 'stock_pledge_summary', + 'params': ('page', 'page_size'), + }, + 'stock_prev_close': { + 'path': 'api/v1/market/data/daec/history/prev-closes', + 'title': '标的昨收价', + 'doc_file': '标的昨收价.md', + 'original_api': 'stock_prev_close', + 'params': ('symbol', 'since', 'until'), + }, + 'stock_intraday_prices': { + 'path': 'api/v1/market/data/daec/history/prices', + 'title': '标的分时数据', + 'doc_file': '标得分时数据.md', + 'original_api': 'stock_intraday_prices', + 'params': ('symbol', 'range', 'days', 'ts_ms'), + }, + 'stock_rating_top5': { + 'path': 'api/v1/market/data/feitu/stock-rating-top5', + 'title': '飞兔股票评级Top5', + 'doc_file': '飞兔股票评级Top5.md', + 'original_api': 'stock_rating_top5', + 'params': ('date', 'variant', 'type'), + }, + 'stock_share': { + 'path': 'api/v1/market/data/share/get-stock-share', + 'title': '股本', + 'doc_file': '股本.md', + 'original_api': 'get_stock_share_handler', + 'params': ('stock_code', 'date'), + }, + 'stock_share_chg': { + 'path': 'api/v1/market/data/holder/stock-share-chg', + 'title': '股东增减持', + 'doc_file': '股东增减持.md', + 'original_api': 'stock_share_chg', + 'params': ('stock_code', 'is_last', 'page', 'page_size'), + }, + 'stock_signal_latest_snapshot': { + 'path': 'api/v1/market/data/stock-signal-latest-snapshot', + 'title': '信号最新快照', + 'doc_file': '信号最新快照.md', + 'original_api': 'stock_signal_latest_snapshot', + 'params': ('signal_type', 'page', 'page_size'), + }, + 'stock_trade': { + 'path': 'api/v1/market/data/daec/history/trades', + 'title': '标的逐笔成交', + 'doc_file': '标的逐笔成交.md', + 'original_api': 'stock_trade', + 'params': ('symbol',), + }, + 'stock_unlock': { + 'path': 'api/v1/market/data/unlock/stock-unlock', + 'title': '限售解禁', + 'doc_file': '限售解禁.md', + 'original_api': 'stock_unlock_handler', + 'params': ('stock_code', 'page', 'page_size'), + }, + 'stock_unlock_by_date': { + 'path': 'api/v1/market/data/unlock/stock-unlock-by-date', + 'title': '限售解禁按日期', + 'doc_file': '限售解禁按日期.md', + 'original_api': 'stock_unlock_by_date_handler', + 'params': ('start_date', 'end_date', 'page', 'page_size'), + }, + 'suspension_list': { + 'path': 'api/v1/market/data/suspension-list', + 'title': '停牌列表', + 'doc_file': '停牌列表.md', + 'original_api': 'suspension_list', + 'params': ('trade_date', 'page', 'page_size'), + }, + 'sz_hk_stock_connect_members': { + 'path': 'api/v1/market/data/sz-hk-stock-connect-members', + 'title': '深股通成份', + 'doc_file': '深股通成份.md', + 'original_api': 'sz_hk_stock_connect_members', + }, + 'ths_all_board_kline': { + 'path': 'api/v1/market/data/ths-all-board-kline', + 'title': '同花顺全板块K线', + 'doc_file': '同花顺全板块K线.md', + 'original_api': 'ths_all_board_kline', + 'params': ('start_date', 'end_date', 'page', 'page_size'), + }, + 'ths_board_kline': { + 'path': 'api/v1/market/data/ths-board-kline', + 'title': '同花顺板块K线', + 'doc_file': '同花顺板块K线.md', + 'original_api': 'ths_board_kline', + 'params': ('board_code', 'page', 'page_size'), + }, + 'ths_board_list': { + 'path': 'api/v1/market/data/ths-board-list', + 'title': '同花顺板块列表', + 'doc_file': '同花顺板块列表.md', + 'original_api': 'ths_board_list', + }, + 'xueqiu_rank': { + 'path': 'api/v1/market/data/xueqiu-rank', + 'title': '雪球股票排名', + 'doc_file': '雪球股票排名.md', + 'original_api': 'xueqiu_rank', + 'params': ('rank_group', 'period', 'trade_date', 'page', 'page_size'), + 'max_page_size': 100, + }, + 'yzxdr_detail': { + 'path': 'api/v1/market/data/yzxdr-detail', + 'title': '除权除息明细', + 'doc_file': '除权除息明细.md', + 'original_api': 'get_yzxdr_detail', + 'params': ('year', 'quarter', 'stock_code', 'page', 'page_size'), + }, + 'pledge_summary': { + 'path': 'api/v1/market/data/pledge/pledge-summary', + 'title': '股权质押汇总', + 'doc_file': '股权质押汇总.md', + 'original_api': 'stock_pledge_summary', + 'params': ('page', 'page_size'), + }, + 'stock_capital_flows': { + 'path': 'api/v1/market/data/stock-capital-flows', + 'title': '股票资金流向', + 'doc_file': '股票资金流向.md', + 'original_api': 'stock_capital_flows_paginated', + 'params': ('date', 'page', 'page_size'), + }, +}) diff --git a/src/ftshare/endpoints/types.py b/src/ftshare/endpoints/types.py new file mode 100644 index 0000000..8916490 --- /dev/null +++ b/src/ftshare/endpoints/types.py @@ -0,0 +1,40 @@ +"""Endpoint metadata types for FTShare market data.""" + +from __future__ import annotations + +from collections.abc import Mapping +from dataclasses import dataclass +from typing import Any + + +@dataclass(frozen=True) +class Endpoint: + """Metadata for a single FTShare API endpoint.""" + + name: str + path: str | None + method: str = "GET" + title: str = "" + doc_file: str | None = None + original_api: str = "" + params: tuple[str, ...] = () + path_params: tuple[str, ...] = () + max_page_size: int = 200 + + +def build_endpoints(specs: Mapping[str, Mapping[str, Any]]) -> dict[str, Endpoint]: + """Build endpoint objects from compact ftshare-doc topic specs.""" + return { + name: Endpoint( + name=name, + path=spec["path"], + method=spec.get("method", "GET"), + title=spec.get("title", ""), + doc_file=spec.get("doc_file"), + original_api=spec.get("original_api", ""), + params=tuple(spec.get("params", ())), + path_params=tuple(spec.get("path_params", ())), + max_page_size=spec.get("max_page_size", 200), + ) + for name, spec in specs.items() + } diff --git a/src/ftshare/endpoints/unpublished.py b/src/ftshare/endpoints/unpublished.py new file mode 100644 index 0000000..4de727f --- /dev/null +++ b/src/ftshare/endpoints/unpublished.py @@ -0,0 +1,39 @@ +"""Unpublished endpoints that still have SDK coverage.""" + +from __future__ import annotations + +from .types import Endpoint, build_endpoints + + +ENDPOINTS: dict[str, Endpoint] = build_endpoints({ + 'stock_dividends_paginated': { + 'path': 'api/v1/market/data/dividends', + 'title': '股票分红记录分页', + 'doc_file': '股票分红记录分页.md', + 'original_api': 'stock_dividends_paginated', + 'params': ('page', 'page_size'), + }, + 'stock_intraday': { + 'path': 'api/v1/market/security/{symbol}/intraday', + 'title': '股票日内分时', + 'doc_file': '股票日内分时.md', + 'original_api': 'stock_intraday', + 'params': ('symbol',), + 'path_params': ('symbol',), + }, + 'stock_ipos_paginated': { + 'path': 'api/v1/market/data/stock-ipos', + 'title': '股票IPO分页', + 'doc_file': '股票IPO分页.md', + 'original_api': 'stock_ipos_paginated', + 'params': ('page', 'page_size'), + }, + 'stock_related': { + 'path': 'api/v1/market/security/{symbol}/related', + 'title': '相关股票', + 'doc_file': '相关股票.md', + 'original_api': 'stock_related', + 'params': ('symbol', 'limit'), + 'path_params': ('symbol',), + }, +}) diff --git a/src/ftshare/endpoints/us.py b/src/ftshare/endpoints/us.py new file mode 100644 index 0000000..d563ecb --- /dev/null +++ b/src/ftshare/endpoints/us.py @@ -0,0 +1,76 @@ +"""US market endpoints generated from ftshare-doc.""" + +from __future__ import annotations + +from .types import Endpoint, build_endpoints + + +ENDPOINTS: dict[str, Endpoint] = build_endpoints({ + 'eastmoney_us_stock_daily_kline': { + 'path': 'api/v1/market/data/eastmoney-us-stock-daily-ohlc', + 'title': '东方财富美股日OHLC', + 'doc_file': '东方财富美股日OHLC.md', + 'original_api': 'eastmoney_us_stock_daily_kline', + 'params': ('stock_code', 'start_date', 'end_date', 'page', 'page_size'), + }, + 'eastmoney_us_stock_latest_kline': { + 'path': 'api/v1/market/data/eastmoney-us-stock-latest-ohlc', + 'title': '东方财富美股最新OHLC', + 'doc_file': '东方财富美股最新OHLC.md', + 'original_api': 'eastmoney_us_stock_latest_kline', + 'params': ('stock_code', 'page', 'page_size'), + }, + 'eastmoney_us_stock_list': { + 'path': 'api/v1/market/data/eastmoney-us-stock-list', + 'title': '东方财富美股列表', + 'doc_file': '东方财富美股列表.md', + 'original_api': 'eastmoney_us_stock_list', + 'params': ('refresh', 'page', 'page_size'), + }, + 'us_balance': { + 'path': 'api/v1/market/data/us/us-balance', + 'title': '美股资产负债表', + 'doc_file': '美股资产负债表.md', + 'original_api': 'us_balance', + 'params': ('stock_code', 'period', 'report_type', 'start_date', 'end_date', 'page', 'page_size'), + 'max_page_size': 500, + }, + 'us_basic': { + 'path': 'api/v1/market/data/us/us-basic', + 'title': '美股基础信息', + 'doc_file': '美股基础信息.md', + 'original_api': 'us_basic', + 'params': ('stock_code', 'page', 'page_size'), + 'max_page_size': 500, + }, + 'us_cashflow': { + 'path': 'api/v1/market/data/us/us-cashflow', + 'title': '美股现金流', + 'doc_file': '美股现金流.md', + 'original_api': 'us_cashflow', + 'params': ('stock_code', 'period', 'report_type', 'start_date', 'end_date', 'page', 'page_size'), + 'max_page_size': 500, + }, + 'us_income': { + 'path': 'api/v1/market/data/us/us-income', + 'title': '美股利润表', + 'doc_file': '美股利润表.md', + 'original_api': 'us_income', + 'params': ('stock_code', 'period', 'report_type', 'start_date', 'end_date', 'page', 'page_size'), + 'max_page_size': 500, + }, + 'eastmoney_us_stock_daily_ohlc': { + 'path': 'api/v1/market/data/eastmoney-us-stock-daily-ohlc', + 'title': '东方财富美股日OHLC', + 'doc_file': '东方财富美股日OHLC.md', + 'original_api': 'eastmoney_us_stock_daily_kline', + 'params': ('stock_code', 'start_date', 'end_date', 'page', 'page_size'), + }, + 'eastmoney_us_stock_latest_ohlc': { + 'path': 'api/v1/market/data/eastmoney-us-stock-latest-ohlc', + 'title': '东方财富美股最新OHLC', + 'doc_file': '东方财富美股最新OHLC.md', + 'original_api': 'eastmoney_us_stock_latest_kline', + 'params': ('stock_code', 'page', 'page_size'), + }, +}) diff --git a/tests/test_client.py b/tests/test_client.py index 8caaf10..29d7efe 100644 --- a/tests/test_client.py +++ b/tests/test_client.py @@ -54,12 +54,12 @@ def paginated_records(records, page=1, pages=1): def test_default_base_url_and_set_base_url(): - assert ft.BASE_URL == "https://market.ft.tech/data/" - assert ft.set_base_url("https://example.com/data") == "https://example.com/data/" - assert ft.BASE_URL == "https://example.com/data/" + assert ft.BASE_URL == "https://market.ft.tech/gateway/" + assert ft.set_base_url("https://example.com/gateway") == "https://example.com/gateway/" + assert ft.BASE_URL == "https://example.com/gateway/" client = ft.market_api() - assert client.base_url == "https://example.com/data/" - ft.set_base_url("https://market.ft.tech/data/") + assert client.base_url == "https://example.com/gateway/" + ft.set_base_url("https://market.ft.tech/gateway/") def test_package_base_url_assignment_is_used_by_market_api(): @@ -73,21 +73,30 @@ def test_package_base_url_assignment_is_used_by_market_api(): def test_url_join_and_none_params_are_filtered(): session = FakeSession([FakeResponse(payload={"items": [], "total_pages": 0, "total_items": 0})]) - client = FtshareClient(base_url="https://market.ft.tech/data/", session=session) + client = FtshareClient(base_url="https://market.ft.tech/gateway/", session=session) client.stk_limit(symbol="000001.SZ", trade_date=None, page=1) - assert session.calls[0]["url"] == "https://market.ft.tech/data/api/v1/market/data/stk-limit" + assert session.calls[0]["url"] == "https://market.ft.tech/gateway/api/v1/market/data/stk-limit" assert session.calls[0]["params"] == {"symbol": "000001.SZ", "page": 1} def test_data_prefix_is_not_duplicated(): session = FakeSession([FakeResponse(payload={})]) - client = FtshareClient(base_url="https://market.ft.tech/data/", session=session) + client = FtshareClient(base_url="https://market.ft.tech/gateway/", session=session) client.get("/data/api/v1/market/data/demo") - assert session.calls[0]["url"] == "https://market.ft.tech/data/api/v1/market/data/demo" + assert session.calls[0]["url"] == "https://market.ft.tech/gateway/api/v1/market/data/demo" + + +def test_gateway_prefix_is_not_duplicated(): + session = FakeSession([FakeResponse(payload={})]) + client = FtshareClient(base_url="https://market.ft.tech/gateway/", session=session) + + client.get("/gateway/api/v1/market/data/demo") + + assert session.calls[0]["url"] == "https://market.ft.tech/gateway/api/v1/market/data/demo" def test_get_defaults_to_extracted_records(): @@ -149,12 +158,12 @@ def test_endpoint_methods_map_to_expected_paths(method_name, kwargs): getattr(client, method_name)(**kwargs) - assert session.calls[0]["url"] == "https://market.ft.tech/data/" + ENDPOINTS[method_name].path + assert session.calls[0]["url"] == "https://market.ft.tech/gateway/" + ENDPOINTS[method_name].path def test_all_documented_endpoints_are_available_as_client_methods(): client = FtshareClient(session=FakeSession([])) - assert len(ENDPOINTS) >= 176 + assert len(ENDPOINTS) >= 179 missing = [ name @@ -215,7 +224,7 @@ def test_search_uses_public_path_without_trailing_slash_and_q_param(): rows = client.search(query="maotai", limit=1, as_dataframe=False) assert rows == [{"symbol": "600519.SH"}] - assert session.calls[0]["url"] == "https://market.ft.tech/data/api/v1/market/security/search" + assert session.calls[0]["url"] == "https://market.ft.tech/gateway/api/v1/market/security/search" assert session.calls[0]["params"] == {"q": "maotai", "limit": 1} @@ -226,7 +235,7 @@ def test_path_parameter_is_substituted_into_endpoint_url(): rows = client.stock_intraday(symbol="600000.XSHG", as_dataframe=False) assert rows == [] - assert session.calls[0]["url"] == "https://market.ft.tech/data/api/v1/market/security/600000.XSHG/intraday" + assert session.calls[0]["url"] == "https://market.ft.tech/gateway/api/v1/market/security/600000.XSHG/intraday" assert session.calls[0]["params"] == {} @@ -236,7 +245,7 @@ def test_path_parameter_and_query_parameters_are_separated(): client.stock_related(symbol="000300.XSHG", limit=3) - assert session.calls[0]["url"] == "https://market.ft.tech/data/api/v1/market/security/000300.XSHG/related" + assert session.calls[0]["url"] == "https://market.ft.tech/gateway/api/v1/market/security/000300.XSHG/related" assert session.calls[0]["params"] == {"limit": 3} @@ -268,6 +277,12 @@ def test_confirmed_todo_endpoints_map_to_public_server_paths(): "api/v1/market/data/daec/market/distribution-history", {"scope": "ChinaStock"}, ), + ( + "stock_intraday_prices", + {"symbol": "600000.XSHG", "range": "Today"}, + "api/v1/market/data/daec/history/prices", + {"symbol": "600000.XSHG", "range": "Today"}, + ), ] for method_name, kwargs, path, expected_params in cases: @@ -276,7 +291,33 @@ def test_confirmed_todo_endpoints_map_to_public_server_paths(): getattr(client, method_name)(**kwargs) - assert session.calls[0]["url"] == "https://market.ft.tech/data/" + path + assert session.calls[0]["url"] == "https://market.ft.tech/gateway/" + path + assert session.calls[0]["params"] == expected_params + + +def test_stock_market_list_families_format_board_path_parameters(): + cases = [ + ( + "stock_daec_stocks", + {"board": "all", "page": 1, "page_size": 5, "filter": "close > 10", "order_by": "change_rate desc"}, + "api/v1/market/data/daec/stocks/all", + {"filter": "close > 10", "order_by": "change_rate desc", "page": 1, "page_size": 5}, + ), + ( + "stock_realtime_list", + {"board": "chi-next", "page": 1, "page_size": 5}, + "api/v1/market/data/stock-list/chi-next", + {"page": 1, "page_size": 5}, + ), + ] + + for method_name, kwargs, path, expected_params in cases: + session = FakeSession([FakeResponse(payload={"items": [], "total_pages": 0, "total_items": 0})]) + client = FtshareClient(session=session) + + getattr(client, method_name)(**kwargs) + + assert session.calls[0]["url"] == "https://market.ft.tech/gateway/" + path assert session.calls[0]["params"] == expected_params @@ -292,9 +333,9 @@ def test_paginated_aliases_resolved_from_server_routes(): client.stock_ipos_paginated(page=1, page_size=50) client.stock_dividends_paginated(page=1, page_size=50) - assert session.calls[0]["url"] == "https://market.ft.tech/data/api/v1/market/data/stock-ipos" + assert session.calls[0]["url"] == "https://market.ft.tech/gateway/api/v1/market/data/stock-ipos" assert session.calls[0]["params"] == {"page": 1, "page_size": 50} - assert session.calls[1]["url"] == "https://market.ft.tech/data/api/v1/market/data/dividends" + assert session.calls[1]["url"] == "https://market.ft.tech/gateway/api/v1/market/data/dividends" assert session.calls[1]["params"] == {"page": 1, "page_size": 50}