Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 16 additions & 23 deletions docs/API_REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,6 @@
### 期货数据

| [`eastmoney_futures_strange`](#api-eastmoney-futures-strange) | 东方财富期货龙虎榜 | `GET` | `api/v1/market/data/eastmoney-futures-strange` | `exchange`, `variety`, `contract`, `trade_date` | `东方财富期货龙虎榜.md` |
| [`futures_minutes_batch`](#api-futures-minutes-batch) | 批量期货历史分钟行情 | `GET` | `api/v2/market/data/futures_minutes/batch` | `symbols`, `interval`, `start`, `end`, `limit` | `批量期货历史分钟行情.md` |
| [`member_build_process`](#api-member-build-process) | 会员建仓过程 | `GET` | `api/v2/market/data/member-build-process` | `exchange`, `member_name`, `instrument_id`, `start_date`, `end_date`, `contract_multiplier`, `page`, `page_size` | `会员建仓过程.md` |
| [`member_position_ranking`](#api-member-position-ranking) | 会员持仓排名 | `GET` | `api/v2/market/data/member-position-ranking` | `exchange`, `instrument_id`, `trade_date`, `direction`, `page`, `page_size` | `会员持仓排名.md` |

Expand Down Expand Up @@ -971,7 +970,7 @@ Documented endpoint: ``get_eastmoney_stock_flow``.

Args:
symbol: 股票代码,如 600522 (type: string; required: N).
trade_date: 交易日 YYYYMMDD;与 start_date/end_date 互斥 (type: string; required: N).
trade_date: 交易日 YYYYMMDD;可与 start_date/end_date 按 AND 条件组合过滤 (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.
Expand Down Expand Up @@ -2920,7 +2919,7 @@ Returns:
- HTTP:`GET`
- Path:`api/v4/market/data/stock-realtime-day-kline`
- 参数:`symbols`
- 说明:`symbols` 支持 list/tuple(SDK 自动序列化为 JSON 字符串数组)或 JSON 字符串。
- 说明:`symbols` 支持 list/tuple(SDK 自动序列化为逗号分隔字符串)或已是逗号分隔/JSON 字符串的代码列表。
- 来源文档:`股票实时日K线.md`
- 原始接口:`stock_realtime_day_kline`

Expand Down Expand Up @@ -2968,7 +2967,7 @@ Returns:
- HTTP:`GET`
- Path:`api/v4/market/data/stock-realtime-minute-kline`
- 参数:`symbols`
- 说明:`symbols` 支持 list/tuple(SDK 自动序列化为 JSON 字符串数组)或 JSON 字符串。
- 说明:`symbols` 支持 list/tuple(SDK 自动序列化为逗号分隔字符串)或已是逗号分隔/JSON 字符串的代码列表。
- 来源文档:`股票实时分钟K线.md`
- 原始接口:`stock_realtime_minute_kline`

Expand Down Expand Up @@ -3799,7 +3798,7 @@ Returns:
- HTTP:`GET`
- Path:`api/v4/market/data/index-realtime-day-kline`
- 参数:`symbols`
- 说明:`symbols` 支持 list/tuple(SDK 自动序列化为 JSON 字符串数组)或 JSON 字符串。
- 说明:`symbols` 支持 list/tuple(SDK 自动序列化为逗号分隔字符串)或已是逗号分隔/JSON 字符串的代码列表。
- 来源文档:`指数实时日K线.md`
- 原始接口:`index_realtime_day_kline`

Expand All @@ -3813,7 +3812,7 @@ Returns:
- HTTP:`GET`
- Path:`api/v4/market/data/index-realtime-minute-kline`
- 参数:`symbols`
- 说明:`symbols` 支持 list/tuple(SDK 自动序列化为 JSON 字符串数组)或 JSON 字符串。
- 说明:`symbols` 支持 list/tuple(SDK 自动序列化为逗号分隔字符串)或已是逗号分隔/JSON 字符串的代码列表。
- 来源文档:`指数实时分钟K线.md`
- 原始接口:`index_realtime_minute_kline`

Expand Down Expand Up @@ -4233,7 +4232,7 @@ Returns:
- HTTP:`GET`
- Path:`api/v4/market/data/etf-realtime-day-kline`
- 参数:`symbols`
- 说明:`symbols` 支持 list/tuple(SDK 自动序列化为 JSON 字符串数组)或 JSON 字符串。
- 说明:`symbols` 支持 list/tuple(SDK 自动序列化为逗号分隔字符串)或已是逗号分隔/JSON 字符串的代码列表。
- 来源文档:`ETF实时日K线.md`
- 原始接口:`etf_realtime_day_kline`

Expand All @@ -4247,7 +4246,7 @@ ETF实时日K线.
- HTTP:`GET`
- Path:`api/v4/market/data/etf-realtime-minute-kline`
- 参数:`symbols`
- 说明:`symbols` 支持 list/tuple(SDK 自动序列化为 JSON 字符串数组)或 JSON 字符串。
- 说明:`symbols` 支持 list/tuple(SDK 自动序列化为逗号分隔字符串)或已是逗号分隔/JSON 字符串的代码列表。
- 来源文档:`ETF实时分钟K线.md`
- 原始接口:`etf_realtime_minute_kline`

Expand Down Expand Up @@ -5172,7 +5171,7 @@ Method: ``GET``.
Documented endpoint: ``futures_kline_batch``.

Args:
symbols: 1~20 个期货合约代码;支持重复参数、逗号分隔或列表 (type: string[]; required: Y).
symbols: 1~20 个期货合约代码;使用逗号分隔,兼容重复参数 (type: string; required: Y).
interval: K 线周期,默认 ``daily`` (type: string; required: N).
start: 起始时间戳,单位毫秒 (type: integer; required: N).
end: 结束时间戳,单位毫秒,不能单独传 (type: integer; required: N).
Expand Down Expand Up @@ -5205,7 +5204,7 @@ Documented endpoint: ``futures_minutes``.

Args:
symbol: 单个期货合约代码,带交易所短后缀;与 ``symbols`` 二选一 (type: string; required: N).
symbols: 1~20 个期货合约代码;支持重复参数、逗号分隔或列表;与 ``symbol`` 二选一 (type: string[]; required: N).
symbols: 1~20 个期货合约代码;使用逗号分隔,兼容重复参数;与 ``symbol`` 二选一 (type: string; required: N).
interval: 分钟周期,默认 ``1min`` (type: string; required: N).
start: 起始时间戳,单位毫秒;必填 (type: integer; required: Y).
end: 结束时间戳,单位毫秒;必填,不能单独传 (type: integer; required: Y).
Expand Down Expand Up @@ -5237,7 +5236,7 @@ Method: ``GET``.
Documented endpoint: ``futures_minutes_realtime``.

Args:
symbols: 期货合约代码列表,1~20 个 (type: array; required: Y).
symbols: 逗号分隔的期货合约代码列表,1~20 个 (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.
Expand Down Expand Up @@ -5302,7 +5301,7 @@ Method: ``GET``.
Documented endpoint: ``futures_realtime_day_kline``.

Args:
symbols: 1~20 个期货合约代码;支持重复参数、逗号分隔或列表 (type: string[]; required: Y).
symbols: 1~20 个期货合约代码;使用逗号分隔,兼容重复参数 (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.
Expand Down Expand Up @@ -5463,7 +5462,7 @@ Method: ``GET``.
Documented endpoint: ``convertible_bond_candlesticks_batch``.

Args:
symbols: 可转债代码列表,1~20 个;支持重复参数、逗号分隔或 JSON 字符串数组 (type: string[]; required: Y).
symbols: 1~20 个可转债代码;使用逗号分隔,兼容重复参数和 JSON 字符串数组 (type: string; required: Y).
interval_unit: 周期单位:Day/Week/Month/Year,大小写不敏感 (type: enum; required: Y).
adjust_kind: 复权:None(默认,不复权)/Forward(前复权)/Backward(后复权) (type: enum; required: N).
since_ts_millis: 起始时间戳,单位毫秒;不得晚于 until,且与 until 相差不超过 12 个自然月 (type: int(ms); required: Y).
Expand Down Expand Up @@ -5498,10 +5497,10 @@ Documented endpoint: ``convertible_bond_minute_candlesticks``.

Args:
symbol: 单只可转债代码(与 symbols 二选一,不能同时传) (type: string; required: N).
symbols: 1~20 个可转债代码;支持重复参数、逗号分隔或 JSON 字符串数组(与 symbol 二选一) (type: string[]; required: N).
symbols: 1~20 个可转债代码;使用逗号分隔,兼容重复参数和 JSON 字符串数组(与 symbol 二选一) (type: string; required: N).
interval_value: 分钟周期:仅支持 1、5、15,默认 1 (type: enum; required: N).
since_ts_millis: 起始时间戳,单位毫秒;单只、批量都必须提供 (type: int(ms); required: Y).
until_ts_millis: 结束时间戳,单位毫秒;不得早于 since,且单次跨度不超过 3 个自然日 (type: int(ms); required: Y).
until_ts_millis: 结束时间戳,单位毫秒;不得早于 since,且单次跨度不超过 30 个北京时间自然日(包含起止日期,非交易日也计入) (type: int(ms); required: Y).
limit: 每只标的聚合后最多返回条数,范围 1~1000;省略返回窗口内全部记录 (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.
Expand Down Expand Up @@ -5531,7 +5530,7 @@ Method: ``GET``.
Documented endpoint: ``convertible_bond_realtime_day_kline``.

Args:
symbols: 1~20 个可转债代码的 JSON 字符串数组,如 ``["113042.SH","123107.SZ"]``;单只也必须传单元素数组 (type: string; required: Y).
symbols: 1~20 个可转债代码的逗号分隔列表,如 ``113042.SH,123107.SZ``;也兼容 JSON 字符串数组格式;支持带交易所后缀和可推断市场的六码裸代码 (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.
Expand Down Expand Up @@ -5559,7 +5558,7 @@ Method: ``GET``.
Documented endpoint: ``convertible_bond_realtime_minute_kline``.

Args:
symbols: 1~20 个可转债代码的 JSON 字符串数组,如 ``["113042.SH","123107.SZ"]``;单只也必须传单元素数组 (type: string; required: Y).
symbols: 1~20 个可转债代码的逗号分隔列表,如 ``113042.SH,123107.SZ``;也兼容 JSON 字符串数组格式;支持带交易所后缀和可推断市场的六码裸代码 (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.
Expand Down Expand Up @@ -6722,12 +6721,6 @@ Returns:
- 参数:`exchange, variety, contract, trade_date`
- 来源文档:`东方财富期货龙虎榜.md`

<h4 id="api-futures-minutes-batch"><code>futures_minutes_batch</code></h4>

- Path:`api/v2/market/data/futures_minutes/batch`
- 参数:`symbols, interval, start, end, limit`
- 来源文档:`批量期货历史分钟行情.md`

<h4 id="api-member-build-process"><code>member_build_process</code></h4>

- Path:`api/v2/market/data/member-build-process`
Expand Down
20 changes: 10 additions & 10 deletions src/ftshare/apis/bond.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
from typing import Any

from ..endpoints import ENDPOINTS
from ..params import symbols_to_json_string
from ..params import symbols_to_csv_string


class BondApiMixin:
Expand Down Expand Up @@ -80,7 +80,7 @@ def convertible_bond_candlesticks_batch(
Documented endpoint: ``convertible_bond_candlesticks_batch``.

Args:
symbols: 可转债代码列表,1~20 个;支持重复参数、逗号分隔或 JSON 字符串数组 (type: string[]; required: Y).
symbols: 1~20 个可转债代码;使用逗号分隔,兼容重复参数和 JSON 字符串数组 (type: string; required: Y).
interval_unit: 周期单位:Day/Week/Month/Year,大小写不敏感 (type: enum; required: Y).
adjust_kind: 复权:None(默认,不复权)/Forward(前复权)/Backward(后复权) (type: enum; required: N).
since_ts_millis: 起始时间戳,单位毫秒;不得晚于 until,且与 until 相差不超过 12 个自然月 (type: int(ms); required: Y).
Expand All @@ -96,7 +96,7 @@ def convertible_bond_candlesticks_batch(
``as_dataframe=False``, raw JSON when ``raw=True``, or raw page
payloads when multi-page fetching is used with ``raw=True``.
"""
request_params = {'symbols': symbols, 'interval_unit': interval_unit, 'adjust_kind': adjust_kind, 'since_ts_millis': since_ts_millis, 'until_ts_millis': until_ts_millis, 'limit': limit}
request_params = {'symbols': symbols_to_csv_string(symbols), 'interval_unit': interval_unit, 'adjust_kind': adjust_kind, 'since_ts_millis': since_ts_millis, 'until_ts_millis': until_ts_millis, 'limit': limit}
request_params.update(kwargs)
return self._call_endpoint(
'convertible_bond_candlesticks_batch',
Expand Down Expand Up @@ -128,10 +128,10 @@ def convertible_bond_minute_candlesticks(

Args:
symbol: 单只可转债代码(与 symbols 二选一,不能同时传) (type: string; required: N).
symbols: 1~20 个可转债代码;支持重复参数、逗号分隔或 JSON 字符串数组(与 symbol 二选一) (type: string[]; required: N).
symbols: 1~20 个可转债代码;使用逗号分隔,兼容重复参数和 JSON 字符串数组(与 symbol 二选一) (type: string; required: N).
interval_value: 分钟周期:仅支持 1、5、15,默认 1 (type: enum; required: N).
since_ts_millis: 起始时间戳,单位毫秒;单只、批量都必须提供 (type: int(ms); required: Y).
until_ts_millis: 结束时间戳,单位毫秒;不得早于 since,且单次跨度不超过 3 个自然日 (type: int(ms); required: Y).
until_ts_millis: 结束时间戳,单位毫秒;不得早于 since,且单次跨度不超过 30 个北京时间自然日(包含起止日期,非交易日也计入) (type: int(ms); required: Y).
limit: 每只标的聚合后最多返回条数,范围 1~1000;省略返回窗口内全部记录 (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.
Expand All @@ -143,7 +143,7 @@ def convertible_bond_minute_candlesticks(
``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, 'symbols': symbols, 'interval_value': interval_value, 'since_ts_millis': since_ts_millis, 'until_ts_millis': until_ts_millis, 'limit': limit}
request_params = {'symbol': symbol, 'symbols': symbols_to_csv_string(symbols), 'interval_value': interval_value, 'since_ts_millis': since_ts_millis, 'until_ts_millis': until_ts_millis, 'limit': limit}
request_params.update(kwargs)
return self._call_endpoint(
'convertible_bond_minute_candlesticks',
Expand All @@ -161,7 +161,7 @@ def convertible_bond_realtime_day_kline(self, symbols: Any | None = None, *, raw
Documented endpoint: ``convertible_bond_realtime_day_kline``.

Args:
symbols: 1~20 个可转债代码的 JSON 字符串数组,如 ``["113042.SH","123107.SZ"]``;单只也必须传单元素数组 (type: string; required: Y).
symbols: 1~20 个可转债代码的逗号分隔列表,如 ``113042.SH,123107.SZ``;也兼容 JSON 字符串数组格式;支持带交易所后缀和可推断市场的六码裸代码 (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.
Expand All @@ -171,7 +171,7 @@ def convertible_bond_realtime_day_kline(self, symbols: Any | None = None, *, raw
A pandas ``DataFrame`` by default, Python rows when
``as_dataframe=False``, or raw JSON when ``raw=True``.
"""
params = {'symbols': symbols_to_json_string(symbols)}
params = {'symbols': symbols_to_csv_string(symbols)}
params.update(kwargs)
return self._call_endpoint('convertible_bond_realtime_day_kline', raw=raw, fields=fields, as_dataframe=as_dataframe, **params)

Expand All @@ -183,7 +183,7 @@ def convertible_bond_realtime_minute_kline(self, symbols: Any | None = None, *,
Documented endpoint: ``convertible_bond_realtime_minute_kline``.

Args:
symbols: 1~20 个可转债代码的 JSON 字符串数组,如 ``["113042.SH","123107.SZ"]``;单只也必须传单元素数组 (type: string; required: Y).
symbols: 1~20 个可转债代码的逗号分隔列表,如 ``113042.SH,123107.SZ``;也兼容 JSON 字符串数组格式;支持带交易所后缀和可推断市场的六码裸代码 (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.
Expand All @@ -193,7 +193,7 @@ def convertible_bond_realtime_minute_kline(self, symbols: Any | None = None, *,
A pandas ``DataFrame`` by default, Python rows when
``as_dataframe=False``, or raw JSON when ``raw=True``.
"""
params = {'symbols': symbols_to_json_string(symbols)}
params = {'symbols': symbols_to_csv_string(symbols)}
params.update(kwargs)
return self._call_endpoint('convertible_bond_realtime_minute_kline', raw=raw, fields=fields, as_dataframe=as_dataframe, **params)

Expand Down
Loading
Loading