feat(tsl-api-reference): expand and reorganize api catalog

Flatten builtin pages, add third-party and platform scopes, and import financial and data warehouse references.

Keep the existing generated index without rebuilding after signature normalization.
This commit is contained in:
csh
2026-08-10 18:26:24 +08:00
parent 2938300acb
commit 9010829c6d
1186 changed files with 243901 additions and 219769 deletions
@@ -0,0 +1,422 @@
# 金融 / 指数 / 限售解禁
## `indexRestrictedBanAndNRsPercent(index_id, endt, vtype)`
声明:function
指定日解禁市值占未流通市值(解禁前)比例(%)
| 参数 | 类型 | 说明 |
| ---------- | -------- | ------------------- |
| `index_id` | string | 指数,指数代码 |
| `endt` | datetime | 日期,截止日期 |
| `vtype` | int | 用户自定义,限售类型 |
返回:float
### 示例
范例01:沪深300板块在20250916的解禁市值占未流通市值比例(%)
```tsl
// 沪深300板块在20250916的解禁市值占未流通市值比例(%)
indexid := 'SH000300';
endt := 20250916T;
return IndexRestrictedBanAndNRSPercent(IndexID, Endt, 0);
// 输出:0.79
```
## `indexRestrictedBanAndNRsPercentQJ(index_id, begt, endt, vtype)`
声明:function
区间解禁市值占未流通市值(解禁前)比例(%)
| 参数 | 类型 | 说明 |
| ---------- | -------- | ------------------- |
| `index_id` | string | 指数,指数代码 |
| `begt` | datetime | 日期,开始日期 |
| `endt` | datetime | 日期,截止日期 |
| `vtype` | int | 用户自定义,限售类型 |
返回:float
### 示例
范例01:沪深300板块在20250910到20250916的解禁市值占未流通市值比例(%)
```tsl
// 沪深300板块在20250910到20250916的解禁市值占未流通市值比例(%)
indexid := 'SH000300';
begt := 20250910T;
endt := 20250916T;
return IndexRestrictedBanAndNRSPercentQJ(IndexID, Begt, Endt, 0);
// 输出:0.79
```
## `indexRestrictedBanAndRSPercent(index_id, endt, vtype)`
声明:function
指定日解禁市值占流通市值(解禁前)比例(%)
| 参数 | 类型 | 说明 |
| ---------- | -------- | ------------------- |
| `index_id` | string | 指数,指数代码 |
| `endt` | datetime | 日期,截止日期 |
| `vtype` | int | 用户自定义,限售类型 |
返回:float
### 示例
范例01:沪深300板块在20250916的解禁市值占未流通市值比例(%)
```tsl
// 沪深300板块在20250916的解禁市值占未流通市值比例(%)
indexid := 'SH000300';
endt := 20250916T;
return IndexRestrictedBanAndRSPercent(IndexID, Endt, 0);
// 输出:0.24
```
## `indexRestrictedBanAndRSPercentQJ(index_id, begt, endt, vtype)`
声明:function
区间解禁市值占流通市值(解禁前)比例(%)
| 参数 | 类型 | 说明 |
| ---------- | -------- | ------------------- |
| `index_id` | string | 指数,指数代码 |
| `begt` | datetime | 日期,开始日期 |
| `endt` | datetime | 日期,截止日期 |
| `vtype` | int | 用户自定义,限售类型 |
返回:float
### 示例
范例01:沪深300板块在20250910到20250916的解禁市值占流通市值比例(%)
```tsl
// 沪深300板块在20250910到20250916的解禁市值占流通市值比例(%)
indexid := 'SH000300';
begt := 20250910T;
endt := 20250916T;
return IndexRestrictedBanAndRSPercentQJ(IndexID, Begt, Endt, 0);
// 输出:0.24
```
## `indexRestrictedBanFutureAndNRsPercentQJ(index_id, endt, vtype, dtype)`
声明:function
指定日未来解禁市值占未流通市值(解禁前)比例(%),其中未来解禁市值: 小于等于今天(today()):SUM(解禁数量\*收盘价(历史)) 大于今天(today()):SUM(解禁数量\*收盘价(Endt))
| 参数 | 类型 | 说明 |
| ---------- | -------- | ------------------- |
| `index_id` | string | 指数,指数代码 |
| `endt` | datetime | 日期,截止日期 |
| `vtype` | int | 用户自定义,限售类型 |
| `dtype` | int | 用户自定义,区间时间 |
返回:float
### 示例
范例01:沪深300板块在20250916当日的未来一周的解禁市值占未流通市值比例(%)
```tsl
// 沪深300板块在20250916当日的未来一周的解禁市值占未流通市值比例(%)
indexid := 'SH000300';
endt := 20250916T;
return IndexRestrictedBanFutureAndNRSPercentQJ(IndexID, Endt, 0, 1);
// 输出:0.027
```
## `indexRestrictedBanFutureAndRSPercentQJ(index_id, endt, vtype, dtype)`
声明:function
指定日未来解禁市值占流通市值(解禁前)比例(%),其中未来解禁市值: 小于等于今天(today()):SUM(解禁数量\*收盘价(历史)) 大于今天(today()):SUM(解禁数量\*收盘价(Endt))
| 参数 | 类型 | 说明 |
| ---------- | -------- | ------------------- |
| `index_id` | string | 指数,指数代码 |
| `endt` | datetime | 日期,截止日期 |
| `vtype` | int | 用户自定义,限售类型 |
| `dtype` | int | 用户自定义,区间时间 |
返回:float
### 示例
范例01:沪深300板块在20250916当日的未来一周的解禁市值占流通市值比例(%)
```tsl
// 沪深300板块在20250916当日的未来一周的解禁市值占流通市值比例(%)
indexid := 'SH000300';
endt := 20250916T;
return IndexRestrictedBanFutureAndRSPercentQJ(IndexID, Endt, 0, 1);
// 输出:0.008
```
## `indexRestrictedBanFutureMVPercentQJ(index_id, endt, vtype, dtype)`
声明:function
指定日未来解禁市值占总市值比例(%),其中未来解禁市值: 小于等于今天(today()):SUM(解禁数量\*收盘价(历史)) 大于今天(today()):SUM(解禁数量\*收盘价(Endt))
| 参数 | 类型 | 说明 |
| ---------- | -------- | ------------------- |
| `index_id` | string | 指数,指数代码 |
| `endt` | datetime | 日期,截止日期 |
| `vtype` | int | 用户自定义,限售类型 |
| `dtype` | int | 用户自定义,区间时间 |
返回:float
### 示例
范例01:沪深300板块在20250916当日的未来一周的解禁市值占总市值比例(%)
```tsl
// 沪深300板块在20250916当日的未来一周的解禁市值占总市值比例(%)
indexid := 'SH000300';
endt := 20250916T;
return IndexRestrictedBanFutureMVPercentQJ(IndexID, Endt, 0, 1);
// 输出:0.006
```
## `indexRestrictedBanFutureNum(index_id, endt, vtype, dtype)`
声明:function
指定日未来解禁家数
| 参数 | 类型 | 说明 |
| ---------- | -------- | ------------------- |
| `index_id` | string | 指数,指数代码 |
| `endt` | datetime | 日期,截止日期 |
| `vtype` | int | 用户自定义,限售类型 |
| `dtype` | int | 用户自定义,区间时间 |
返回:float
### 示例
范例01:沪深300板块在20250916当日的未来一周的解禁家数
```tsl
// 沪深300板块在20250916当日的未来一周的解禁家数
indexid := 'SH000300';
endt := 20250916T;
return IndexRestrictedBanFutureNum(IndexID, Endt, 0, 1);
// 输出:2
```
## `indexRestrictedBanMV(index_id, endt, vtype)`
声明:function
指定日解禁市值(单位:元)
| 参数 | 类型 | 说明 |
| ---------- | -------- | ------------------- |
| `index_id` | string | 指数,指数代码 |
| `endt` | datetime | 日期,截止日期 |
| `vtype` | int | 用户自定义,限售类型 |
返回:float
### 示例
范例01:沪深300板块在20250916的解禁市值
```tsl
// 沪深300板块在20250916的解禁市值
indexid := 'SH000300';
endt := 20250916T;
return IndexRestrictedBanMV(IndexID, Endt, 0);
// 输出:119034026555.92
```
## `indexRestrictedBanMVPercent(index_id, endt, vtype)`
声明:function
指定日解禁市值占总市值比例(%)
| 参数 | 类型 | 说明 |
| ---------- | -------- | ------------------- |
| `index_id` | string | 指数,指数代码 |
| `endt` | datetime | 日期,截止日期 |
| `vtype` | int | 用户自定义,限售类型 |
返回:float
### 示例
范例01:沪深300板块在20250916的解禁市值占总市值比例(%)
```tsl
// 沪深300板块在20250916的解禁市值占总市值比例(%)
indexid := 'SH000300';
endt := 20250916T;
return IndexRestrictedBanMVPercent(IndexID, Endt, 0);
// 输出:0.18
```
## `indexRestrictedBanMVPercentQJ(index_id, begt, endt, vtype)`
声明:function
区间解禁市值占总市值比例(%)
| 参数 | 类型 | 说明 |
| ---------- | ----------- | ------------------- |
| `index_id` | string | 指数,指数代码 |
| `begt` | t_date_time | 日期,开始日期 |
| `endt` | t_date_time | 日期,截止日期 |
| `vtype` | integer | 用户自定义,限售类型 |
返回:real
### 示例
范例01:调用函数
```tsl
// 沪深300板块在20250910到20250916的解禁市值占总市值比例(%)
indexid := 'SH000300';
begt := 20250910T;
endt := 20250916T;
return indexRestrictedBanMvPercentQj(index_id, begt, endt, 0);
// 输出:0.18
```
## `indexRestrictedBanMVQJ(index_id, begt, endt, vtype)`
声明:function
区间解禁市值(单位:元)
| 参数 | 类型 | 说明 |
| ---------- | -------- | ------------------- |
| `index_id` | string | 指数,指数代码 |
| `begt` | datetime | 日期,开始日期 |
| `endt` | datetime | 日期,截止日期 |
| `vtype` | int | 用户自定义,限售类型 |
返回:float
### 示例
范例01:沪深300板块在20250910到20250916的解禁市值
```tsl
// 沪深300板块在20250910到20250916的解禁市值
indexid := 'SH000300';
begt := 20250910T;
endt := 20250916T;
return IndexRestrictedBanMVQJ(IndexID, Begt, Endt, 0);
// 输出:119051796340.9
```
## `indexRestrictedBanNum(index_id, endt, vtype)`
声明:function
指定日解禁家数
| 参数 | 类型 | 说明 |
| ---------- | -------- | ------------------- |
| `index_id` | string | 指数,指数代码 |
| `endt` | datetime | 日期,截止日期 |
| `vtype` | int | 用户自定义,限售类型 |
返回:float
### 示例
范例01:沪深300板块在20250916的解禁家数
```tsl
// 沪深300板块在20250916的解禁家数
indexid := 'SH000300';
endt := 20250916T;
return IndexRestrictedBanNum(IndexID, Endt, 0);
// 输出:3
```
## `indexRestrictedBanNumQJ(index_id, begt, endt, vtype)`
声明:function
区间解禁家数
| 参数 | 类型 | 说明 |
| ---------- | -------- | ------------------- |
| `index_id` | string | 指数,指数代码 |
| `begt` | datetime | 日期,开始日期 |
| `endt` | datetime | 日期,截止日期 |
| `vtype` | int | 用户自定义,限售类型 |
返回:float
### 示例
范例01:沪深300板块在20250910到20250916的解禁家数
```tsl
// 沪深300板块在20250910到20250916的解禁家数
indexid := 'SH000300';
begt := 20250910T;
endt := 20250916T;
return IndexRestrictedBanNumQJ(IndexID, Begt, Endt, 0);
// 输出:4
```