## 提示

- `live-or-trading-module-only`


## 原型

```python
get_sort_msg(sort_type_grp=None, sort_field_name=None, sort_type=1, data_count=100)
```

## 释义

get_sort_msg 是 PTrade 中用于获取板块、行业的快照信息的接口。

研究：不支持；回测：不支持；模拟：官方目录未明确；实盘：支持。

## 参数

| 参数 | 是否必填 | 官方原始定义 |
|---|---:|---|
| `sort_type_grp` | 否 | sort_type_grp=None |
| `sort_field_name` | 否 | sort_field_name=None |
| `sort_type` | 否 | sort_type=1 |
| `data_count` | 否 | data_count=100 |

## 返回值

正常返回一个List列表，里面包含板块、行业代码的涨幅排名信息(list[dict{str:str,...},...])，

返回每个代码的信息包含以下字段内容：

prod_code: 行业代码(str:str)；

prod_name: 行业名称(str:str)；

hq_type_code: 行业板块代码(str:str)；

time_stamp: 时间戳毫秒级(str:int)；

trade_mins: 交易分钟数(str:int)；

trade_status: 交易状态(str:str)；

preclose_px: 昨日收盘价(str:float)；

open_px: 今日开盘价(str:float)；

last_px: 最新价(str:float)；

high_px: 最高价(str:float)；

low_px: 最低价(str:float)；

wavg_px: 加权平均价(str:float)；

business_amount: 总成交量(str:int)；

## 示例

```python
def initialize(context):

g.security = '000001.SZ'

set_universe(g.security)

def handle_data(context, data):

#获取XBHS.DY板块按preclose_px字段排序的排名信息

sort_data = get_sort_msg(sort_type_grp='XBHS.DY', sort_field_name='preclose_px', sort_type=1, data_count=100)

log.info(sort_data)

#获取sort_data排序第一条代码的数据

sort_data_first = sort_data[0]

log.info(sort_data_first)
```

## 详细说明

get_sort_msg(sort_type_grp=None, sort_field_name=None, sort_type=1, data_count=100)

### 使用场景

该函数在交易模块可用

### 接口说明

该接口用于获取板块、行业的快照信息(可按指定字段进行排序展示)。

### 注意事项

证监会行业、聚源行业、概念板块、地域板块所对应标的的行情数据为非标准的交易所下发数据，是由数据源自行按照成分股分类规则进行计算的，存在与三方数据源不一致的情况。如用户需要在策略中使用，应自行评估该数据的合理性

### 参数详细说明

sort_type_grp: 板块或行业的代码(list[str]/str)；(暂时只支持XBHS.DY地域、XBHS.GN概念、XBHS.ZJHHY证监会行业、XBHS.ZS指数、XBHS.HY行业等)

sort_field_name: 需要排序的字段(str)；该字段支持输入的参数如下：

preclose_px: 昨日收盘价；

open_px: 今日开盘价；

last_px: 最新价；

high_px: 最高价；

low_px: 最低价；

wavg_px: 加权平均价；

business_amount: 总成交量；

business_balance: 总成交额；

px_change: 涨跌额；

amplitude: 振幅；

px_change_rate: 涨跌幅；

circulation_amount: 流通股本；

total_shares: 总股本；

market_value: 市值；

circulation_value: 流通市值；

vol_ratio: 量比；

rise_count: 上涨家数；

fall_count: 下跌家数；

sort_type: 排序方式，默认降序(0:升序，1:降序)(int)；

data_count: 数据条数，默认为100，最大为10000(int)；

### 返回值

正常返回一个List列表，里面包含板块、行业代码的涨幅排名信息(list[dict{str:str,...},...])，

返回每个代码的信息包含以下字段内容：

prod_code: 行业代码(str:str)；

prod_name: 行业名称(str:str)；

hq_type_code: 行业板块代码(str:str)；

time_stamp: 时间戳毫秒级(str:int)；

trade_mins: 交易分钟数(str:int)；

trade_status: 交易状态(str:str)；

preclose_px: 昨日收盘价(str:float)；

open_px: 今日开盘价(str:float)；

last_px: 最新价(str:float)；

high_px: 最高价(str:float)；

low_px: 最低价(str:float)；

wavg_px: 加权平均价(str:float)；

business_amount: 总成交量(str:int)；

business_balance: 总成交额(str:int)；

px_change: 涨跌额(str:float)；

amplitude: 振幅(str:int)；

px_change_rate: 涨跌幅(str:float)；

circulation_amount: 流通股本(str:int)；

total_shares: 总股本(str:int)；

market_value: 市值(str:int)；

circulation_value: 流通市值(str:int)；

vol_ratio: 量比(str:float)；

shares_per_hand: 每手股数(str:int)；

rise_count: 上涨家数(str:int)；

fall_count: 下跌家数(str:int)；

member_count: 成员个数(str:int)；

rise_first_grp: 领涨股票(其包含以下五个字段)(str:list[dict{str:int,str:str,str:str,str:float,str:float},...])；

prod_code: 股票代码(str:str)；

prod_name: 证券名称(str:str)；

hq_type_code: 类型代码(str:str)；

last_px: 最新价(str:float)；

px_change_rate: 涨跌幅(str:float)；

fall_first_grp: 领跌股票(其包含以下五个字段)(str:list[dict{str:int,str:str,str:str,str:float,str:float},...])；

prod_code: 股票代码(str:str)；

prod_name: 证券名称(str:str)；

hq_type_code: 类型代码(str:str)；

last_px: 最新价(str:float)；

px_change_rate: 涨跌幅(str:float)；
