> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tickdb.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 行业指标排行

> 查询指定市场按行业指标排序的结果。

## 套餐权限

| 套餐 | 可用 |
| - | :-: |
| 免费版 | ❌ |
| 基础版 | ❌ |
| 专业版 | ✅ |
| 全量套餐（A 股、港股、美股） | ✅ |
| 企业版 | ✅ |

## 注意事项

* 此接口按 `market` 查询，不使用股票代码；返回的 `industry_counter_id` 可用于行业分类层级接口。
* `market` 不区分大小写，文档中的市场代码统一使用大写形式。

## 支持的市场

| 市场 | 示例 |
| - | - |
| 美股 | US |
| 港股 | HK |
| A股 | CN |

## 请求参数

| 参数 | 是否必须 | 说明 |
| - | :-: | - |
| `market` | 是 | 市场代码：`US` 美股、`HK` 港股、`CN` A股 |
| `limit` | 否 | 返回条数，默认 50，范围 `1–200` |

## 请求示例

```bash theme={null}
curl -H "X-API-Key: YOUR_API_KEY" \
  "https://api.tickdb.ai/v1/fundamentals/industries/rank?market=US&limit=50"
```

## 返回字段说明

以下列出 `data` 中的字段；外层 `code=0` 表示成功。

| 字段 | 说明 |
| - | - |
| market | 查询市场。 |
| indicator | 排行指标。 |
| sort\_type | 排序方式。 |
| items | 行业指标排行列表。 |
| └─ industry\_counter\_id | 行业节点 ID。 |
| └─ industry\_name | 行业名称。 |
| └─ rank | 名次。 |
| └─ value | 行业总市值。 |
| └─ change\_percent | 涨跌幅。 |

返回行业 ID、行业名称、排名、行业总市值及变化率；行业 ID 可用于查询行业分类层级。


## OpenAPI

````yaml openapi.yaml GET /v1/fundamentals/industries/rank
openapi: 3.1.0
info:
  title: TickDB API
  description: TickDB 统一实时行情数据 API，提供 REST 和 WebSocket 接入。
  version: 1.0.3
  contact:
    email: support@tickdb.ai
servers:
  - url: https://api.tickdb.ai
    description: 生产环境
security:
  - ApiKeyAuth: []
paths:
  /v1/fundamentals/industries/rank:
    get:
      tags:
        - fundamentals-valuation-industry
      summary: 行业指标排行
      description: 查询指定市场按行业指标排序的结果。
      operationId: getFundamentalsIndustriesRank
      parameters:
        - $ref: '#/components/parameters/RequiredMarketQuery'
        - $ref: '#/components/parameters/IndustryRankLimitQuery'
      responses:
        '200':
          $ref: '#/components/responses/IndustriesRankResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
components:
  parameters:
    RequiredMarketQuery:
      name: market
      in: query
      required: true
      schema:
        type: string
        enum:
          - US
          - HK
          - CN
      description: 市场代码：`US` 美股、`HK` 港股、`CN` A股
    IndustryRankLimitQuery:
      name: limit
      in: query
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 200
        default: 50
      description: 返回条数，默认 50，范围 `1–200`
  responses:
    IndustriesRankResponse:
      description: 行业指标排行响应。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/IndustriesRankEnvelope'
    ErrorResponse:
      description: >-
        错误响应。常见 HTTP 状态包括
        400（参数错误）、401（鉴权失败）、403（权限或配额限制）、404（无匹配数据）、429（请求频率限制）和 503（服务暂不可用）。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            missingAPIKey:
              summary: 缺少 API Key
              value:
                code: '1002'
                message: API key is required. Provide via X-API-Key header
                error: '1002'
            missingKind:
              summary: 缺少必填参数
              value:
                code: 40001
                message: kind is required
                data: null
            endpointForbidden:
              summary: API Key 无权访问该接口
              value:
                code: 3009
                message: This endpoint is not allowed for your API key
                data: null
            marketForbidden:
              summary: API Key 未开放该市场
              value:
                code: 3010
                message: Fundamentals market not allowed for your API key
                data:
                  market: US
            noAvailableSource:
              summary: 数据暂不可用
              value:
                code: 5003
                message: Data is temporarily unavailable
                data: null
            notFound:
              summary: 无匹配数据
              value:
                code: 40404
                message: shareholder detail not found
                data: null
            businessNoData:
              summary: 查询条件无有效业务数据
              value:
                code: 40405
                message: valuation time series not found
                data: null
  schemas:
    IndustriesRankEnvelope:
      allOf:
        - $ref: '#/components/schemas/SuccessEnvelope'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/IndustriesRankData'
    ErrorEnvelope:
      type: object
      required:
        - code
        - message
      properties:
        code:
          description: TickDB API 业务错误码；可能为整数或字符串，客户端应归一化为字符串后比较。
          oneOf:
            - type: integer
            - type: string
        message:
          type: string
          description: 错误说明。
        error:
          type: string
          description: 兼容错误标识；仅部分错误响应返回。
        data:
          description: 可选的错误上下文；可能为 null、对象或数组。
          oneOf:
            - type: 'null'
            - type: object
              additionalProperties: true
            - type: array
              items: {}
    SuccessEnvelope:
      type: object
      required:
        - code
        - data
      properties:
        code:
          type: integer
          const: 0
          description: 业务状态码，成功为 0。
    IndustriesRankData:
      type: object
      required:
        - market
        - indicator
        - sort_type
        - items
      properties:
        market:
          type: string
          description: 市场。
        indicator:
          type: string
          description: 排行指标。
        sort_type:
          type: string
          description: 排序方向。
        items:
          type: array
          description: 行业指标排行列表。
          items:
            $ref: '#/components/schemas/IndustryRankItem'
      additionalProperties: true
    IndustryRankItem:
      type: object
      required:
        - industry_counter_id
        - industry_name
        - rank
        - value
        - change_percent
      properties:
        industry_counter_id:
          type: string
          description: 行业 ID，可用于 industries/tree。
        industry_name:
          type: string
          description: 行业名称。
        rank:
          type: integer
          description: 排名。
        value:
          type:
            - string
            - number
          description: 行业总市值。
        change_percent:
          type:
            - string
            - number
            - 'null'
          description: 变动比例。
      additionalProperties: true
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.